]> kaliko git repositories - mpd-sima.git/blob - sima/lib/plugin.py
Fixed regression introduced with 8870413
[mpd-sima.git] / sima / lib / plugin.py
1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2013-2015, 2020 kaliko <kaliko@azylum.org>
3 #
4 #  This file is part of sima
5 #
6 #  sima is free software: you can redistribute it and/or modify
7 #  it under the terms of the GNU General Public License as published by
8 #  the Free Software Foundation, either version 3 of the License, or
9 #  (at your option) any later version.
10 #
11 #  sima is distributed in the hope that it will be useful,
12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #  GNU General Public License for more details.
15 #
16 #  You should have received a copy of the GNU General Public License
17 #  along with sima.  If not, see <http://www.gnu.org/licenses/>.
18 #
19 #
20 """
21 Plugin object to derive from
22 """
23
24
25 class Plugin:
26     """
27     First non-empty line of the docstring is used as description
28     Rest of the docstring at your convenience.
29
30     The lowercased plugin Name MUST be the same as the module (file name),
31     for instance Plugin → plugin.py
32     It eases plugins discovery and simplifies the code to handle them,
33     IMHO, it's a fair trade-off.
34     """
35
36     @classmethod
37     def info(cls):
38         """self documenting class method
39         """
40         doc = 'Undocumented plugin! Fill "{}" docstring'.format(cls.__name__)
41         if cls.__doc__:
42             doc = cls.__doc__.strip(' \n').splitlines()[0]
43         return {'name': cls.__name__,
44                 'doc': doc,}
45
46     def __init__(self, daemon):
47         self.log = daemon.log
48         self.__daemon = daemon
49         self.player = daemon.player
50         self.plugin_conf = None
51         self.__get_config()
52
53     def __str__(self):
54         return self.__class__.__name__
55
56     def __get_config(self):
57         """Get plugin's specific configuration from global applications's config
58         """
59         conf = self.__daemon.config
60         for sec in conf.sections():  # Discovering plugin conf
61             if sec == self.__class__.__name__.lower():
62                 self.plugin_conf = conf[sec]
63                 if 'priority' not in self.plugin_conf:
64                     self.plugin_conf['priority'] = '80'
65         if not self.plugin_conf:
66             self.plugin_conf = {'priority': '80'}
67         #if self.plugin_conf:
68         #    self.log.debug('Got config for %s: ùs', self, self.plugin_conf)
69
70     @property
71     def priority(self):
72         return self.plugin_conf.get('priority')
73
74     def start(self):
75         """
76         Called when the daemon().run() is called and
77         right after the player has connected successfully.
78         """
79         pass
80
81     def callback_player(self):
82         """
83         Called on player changes, stopped, paused, skipped
84         """
85         pass
86
87     def callback_player_database(self):
88         """
89         Called on player music library changes
90         """
91         pass
92
93     def callback_playlist(self):
94         """
95         Called on playlist changes
96         Not returning data
97         """
98         pass
99
100     def callback_next_song(self):
101         """
102         Could be use to scrobble, maintain an history…
103         Not returning data,
104         """
105         pass
106
107     def callback_need_track(self):
108         """
109         Returns a list of Track objects to add
110         """
111         pass
112
113     def callback_need_track_fb(self):
114         """
115         Called when callback_need_track failled to find tracks to queue
116         Returns a list of Track objects to add
117         """
118         pass
119
120     def shutdown(self):
121         """Called on application shutdown"""
122         pass
123
124
125 # VIM MODLINE
126 # vim: ai ts=4 sw=4 sts=4 expandtab