]> kaliko git repositories - mpd-sima.git/blob - sima/lib/plugin.py
Fixed Track object with MPD >= 0.20 (Closes #12)
[mpd-sima.git] / sima / lib / plugin.py
1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2013-2015 Jack 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 {0}: {1}'.format(self,
69         #                                                    self.plugin_conf))
70
71     @property
72     def priority(self):
73         return self.plugin_conf.get('priority')
74
75     def start(self):
76         """
77         Called when the daemon().run() is called and
78         right after the player has connected successfully.
79         """
80         pass
81
82     def callback_player(self):
83         """
84         Called on player changes, stopped, paused, skipped
85         """
86         pass
87
88     def callback_player_database(self):
89         """
90         Called on player music library changes
91         """
92         pass
93
94     def callback_playlist(self):
95         """
96         Called on playlist changes
97         Not returning data
98         """
99         pass
100
101     def callback_next_song(self):
102         """
103         Could be use to scrobble, maintain an history…
104         Not returning data,
105         """
106         pass
107
108     def callback_need_track(self):
109         """
110         Returns a list of Track objects to add
111         """
112         pass
113
114     def callback_need_track_fb(self):
115         """
116         Called when callback_need_track failled to find tracks to queue
117         Returns a list of Track objects to add
118         """
119         pass
120
121     def shutdown(self):
122         """Called on application shutdown"""
123         pass
124
125
126 # VIM MODLINE
127 # vim: ai ts=4 sw=4 sts=4 expandtab