some more work on plugin manager
[enigma2.git] / lib / python / Plugins / Plugin.py
1 from Components.config import ConfigSubsection, config
2 from Tools.LoadPixmap import LoadPixmap
3
4 config.plugins = ConfigSubsection()
5
6 class PluginDescriptor:
7         """An object to describe a plugin."""
8         
9         # where to list the plugin. Note that there are different call arguments,
10         # so you might not be able to combine them.
11         
12         # supported arguments are:
13         #   session
14         #   servicereference
15         #   reason
16         
17         # you have to ignore unknown kwargs!
18         
19         # argument: session
20         WHERE_EXTENSIONSMENU = 0
21         WHERE_MAINMENU = 1
22         WHERE_PLUGINMENU  = 2
23         # argument: session, serviceref (currently selected)
24         WHERE_MOVIELIST = 3
25         # argument: menuid. Fnc must return list with menuitems (4-tuple of name, fnc to call, entryid or None, weight or None)
26         WHERE_MENU = 4
27         
28         # reason (0: start, 1: end)
29         WHERE_AUTOSTART = 5
30         
31         # start as wizard. In that case, fnc must be tuple (priority,class) with class being a screen class!
32         WHERE_WIZARD = 6
33         
34         # like autostart, but for a session. currently, only session starts are 
35         # delivered, and only on pre-loaded plugins
36         WHERE_SESSIONSTART = 7
37         
38         # start as teletext plugin. arguments: session, serviceref
39         WHERE_TELETEXT = 8
40         
41         # file-scanner, fnc must return a list of Scanners
42         WHERE_FILESCAN = 9
43         
44         # fnc must take an interface name as parameter and return None if the plugin supports an extended setup
45         # or return a function which is called with session and the interface name for extended setup of this interface
46         WHERE_NETWORKSETUP = 10
47         
48         # show up this plugin (or a choicebox with all of them) for long INFO keypress
49         # or return a function which is called with session and the interface name for extended setup of this interface
50         WHERE_EVENTINFO = 11
51
52         # reason (True: Networkconfig read finished, False: Networkconfig reload initiated )
53         WHERE_NETWORKCONFIG_READ = 12
54
55         def __init__(self, name = "Plugin", where = [ ], description = "", icon = None, fnc = None, wakeupfnc = None, internal = False):
56                 self.name = name
57                 self.internal = internal
58                 if isinstance(where, list):
59                         self.where = where
60                 else:
61                         self.where = [ where ]
62                 self.description = description
63
64                 if icon is None or isinstance(icon, str):
65                         self.iconstr = icon
66                         self.icon = None
67                 else:
68                         self.icon = icon
69
70                 self.wakeupfnc = wakeupfnc
71
72                 self.__call__ = fnc
73
74         def updateIcon(self, path):
75                 if isinstance(self.iconstr, str):
76                         self.icon = LoadPixmap('/'.join((path, self.iconstr)))
77                 else:
78                         self.icon = None
79
80         def getWakeupTime(self):
81                 return self.wakeupfnc and self.wakeupfnc() or -1
82
83         def __eq__(self, other):
84                 return self.__call__ == other.__call__