add plugin weight to PluginDescriptor... so the plugin start order can be changed now
[vuplus_dvbapp] / lib / python / Components / PluginComponent.py
old mode 100644 (file)
new mode 100755 (executable)
index 960043d..a713c3b
-import os
+from os import path as os_path, listdir as os_listdir
+from traceback import print_exc
+from sys import stdout
 
-from Tools.Directories import *
-from Screens.Menu import menuupdater
+from Tools.Directories import fileExists
+from Tools.Import import my_import
+from Plugins.Plugin import PluginDescriptor
+import keymapparser
 
 class PluginComponent:
+       firstRun = True
+       restartRequired = False
+       
        def __init__(self):
-               self.plugins = []
+               self.plugins = {}
+               self.pluginList = [ ]
+               self.installedPluginList = [ ]
                self.setPluginPrefix("Plugins.")
-               self.menuEntries = []
-               
+               self.resetWarnings()
+
        def setPluginPrefix(self, prefix):
                self.prefix = prefix
 
-       def getPluginList(self, runAutostartPlugins=False, runAutoendPlugins=False):
-               list = []
-               dir = os.listdir(resolveFilename(SCOPE_PLUGINS))
-               self.menuDelete()
-               self.menuEntries = []
-
-               for x in dir:
-                       path = resolveFilename(SCOPE_PLUGINS, x) + "/"
-                       try:
-                               if os.path.exists(path):
-                                       if fileExists(path + "plugin.py"):
-                                               pluginmodule = self.prefix + x + ".plugin"
-                                               print "trying to import " + pluginmodule
-                                               exec "import " + pluginmodule
-                                               plugin = eval(pluginmodule)
-                                               plugins = plugin.getPlugins()
-                                               try: picturepaths = plugin.getPicturePaths()
-                                               except:
-                                                       picturepaths = []
-                                                       for p in plugins:
-                                                               picturepaths.append("")
+       def addPlugin(self, plugin):
+               if self.firstRun or plugin.needsRestart is False:
+                       self.pluginList.append(plugin)
+                       for x in plugin.where:
+                               self.plugins.setdefault(x, []).append(plugin)
+                               if x == PluginDescriptor.WHERE_AUTOSTART:
+                                       plugin(reason=0)
+               else:
+                       self.restartRequired = True
+                               
+       def removePlugin(self, plugin):
+               self.pluginList.remove(plugin)
+               for x in plugin.where:
+                       self.plugins[x].remove(plugin)
+                       if x == PluginDescriptor.WHERE_AUTOSTART:
+                               plugin(reason=1)
+
+       def readPluginList(self, directory):
+               """enumerates plugins"""
+
+               categories = os_listdir(directory)
+
+               new_plugins = [ ]
+
+               for c in categories:
+                       directory_category = directory + c
+                       if not os_path.isdir(directory_category):
+                               continue
+                       open(directory_category + "/__init__.py", "a").close()
+                       for pluginname in os_listdir(directory_category):
+                               path = directory_category + "/" + pluginname
+                               if os_path.isdir(path):
+                                       if fileExists(path + "/plugin.pyc") or fileExists(path + "/plugin.pyo") or fileExists(path + "/plugin.py"):
                                                try:
-                                                       for menuEntry in plugin.getMenuRegistrationList():
-                                                               self.menuEntries.append([menuEntry, pluginmodule])
-                                               except:
-                                                       pass
-       
-                                               for y in range(len(plugins)):
-                                                       if len(plugins[y]) < 4:
-                                                               list.append((path + picturepaths[y], plugins[y][0] , x, plugins[y][1], plugins[y][2], None))
-                                                       else:
-                                                               list.append((path + picturepaths[y], plugins[y][0] , x, plugins[y][1], plugins[y][2], plugins[y][3]))
-                                               if runAutostartPlugins:
-                                                       try: plugin.autostart()
-                                                       except: pass
-                                               if runAutoendPlugins:
-                                                       try: plugin.autoend()
-                                                       except: pass
-                       except:
-                               print "Directory", path, "contains a faulty plugin"
-               self.menuUpdate()
-               return list
-       
-       def menuDelete(self):
-               for menuEntry in self.menuEntries:
-                       menuupdater.delMenuItem(menuEntry[0][0], menuEntry[0][2], menuEntry[1], menuEntry[0][3])
+                                                       plugin = my_import('.'.join(["Plugins", c, pluginname, "plugin"]))
 
-       def menuUpdate(self):
-               for menuEntry in self.menuEntries:
-                       menuupdater.addMenuItem(menuEntry[0][0], menuEntry[0][2], menuEntry[1], menuEntry[0][3])
-       
-       def runPlugin(self, plugin, session):
-               try:
-                       exec("import " + self.prefix + plugin[2] + ".plugin")
-                       if plugin[3] == "screen":
-                               session.open(eval(self.prefix + plugin[2] + ".plugin." + plugin[4]), plugin[5])
-                       elif plugin[3] == "function":
-                               eval(self.prefix + plugin[2] + ".plugin." + plugin[4])(session, plugin[5])
-               except:
-                       print "exec of plugin failed!"
+                                                       if not plugin.__dict__.has_key("Plugins"):
+                                                               print "Plugin %s doesn't have 'Plugin'-call." % (pluginname)
+                                                               continue
+
+                                                       plugins = plugin.Plugins(path=path)
+                                               except Exception, exc:
+                                                       print "Plugin ", c + "/" + pluginname, "failed to load:", exc
+                                                       print_exc(file=stdout)
+                                                       print "skipping plugin."
+                                                       self.warnings.append( (c + "/" + pluginname, str(exc)) )
+                                                       continue
+
+                                               # allow single entry not to be a list
+                                               if not isinstance(plugins, list):
+                                                       plugins = [ plugins ]
+
+                                               for p in plugins:
+                                                       p.path = path
+                                                       p.updateIcon(path)
+                                                       new_plugins.append(p)
+
+                                               if fileExists(path + "/keymap.xml"):
+                                                       try:
+                                                               keymapparser.readKeymap(path + "/keymap.xml")
+                                                       except Exception, exc:
+                                                               print "keymap for plugin %s/%s failed to load: " % (c, pluginname), exc
+                                                               self.warnings.append( (c + "/" + pluginname, str(exc)) )
+
+               # build a diff between the old list of plugins and the new one
+               # internally, the "fnc" argument will be compared with __eq__
+               plugins_added = [p for p in new_plugins if p not in self.pluginList]
+               plugins_removed = [p for p in self.pluginList if not p.internal and p not in new_plugins]
+               
+               #ignore already installed but reloaded plugins
+               for p in plugins_removed: 
+                       for pa in plugins_added:
+                               if pa.path == p.path and pa.where == p.where:
+                                       pa.needsRestart = False
+
+               for p in plugins_removed:
+                       self.removePlugin(p)
+
+               for p in plugins_added:
+                       if self.firstRun or p.needsRestart is False:
+                               self.addPlugin(p)
+                       else:
+                               for installed_plugin in self.installedPluginList:
+                                       if installed_plugin.path == p.path:
+                                               if installed_plugin.where == p.where:
+                                                       p.needsRestart = False
+                               self.addPlugin(p)
+                                               
+               if self.firstRun:
+                       self.firstRun = False
+                       self.installedPluginList = self.pluginList
+
+       def getPlugins(self, where):
+               """Get list of plugins in a specific category"""
+
+               if not isinstance(where, list):
+                       where = [ where ]
+               res = [ ]
+
+               for x in where:
+                       res.extend(self.plugins.get(x, [ ]))
+               res.sort(key=lambda x:x.weight)
+               return res
+
+       def getPluginsForMenu(self, menuid):
+               res = [ ]
+               for p in self.getPlugins(PluginDescriptor.WHERE_MENU):
+                       res += p(menuid)
+               res.sort(key=lambda x:x.weight)
+               return res
+
+       def clearPluginList(self):
+               self.pluginList = []
+               self.plugins = {}
+
+       def shutdown(self):
+               for p in self.pluginList[:]:
+                       self.removePlugin(p)
+
+       def resetWarnings(self):
+               self.warnings = [ ]
+
+       def getNextWakeupTime(self):
+               wakeup = -1
+               for p in self.pluginList:
+                       current = p.getWakeupTime()
+                       if current > -1 and (wakeup > current or wakeup == -1):
+                               wakeup = current
+               return int(wakeup)
 
 plugins = PluginComponent()