# -*- coding: utf-8 -*-
+# Copyright (c) 2013, 2014 Jack Kaliko <kaliko@azylum.org>
+#
+# This file is part of sima
+#
+# sima is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sima is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with sima. If not, see <http://www.gnu.org/licenses/>.
+#
+#
+"""
+Plugin object to derive from
+"""
+
+class Plugin:
+ """
+ First non-empty line of the docstring is used as description
+ Rest of the docstring at your convenience.
+
+ The lowercased plugin Name MUST be the same as the module (file name),
+ for instance Plugin → plugin.py
+ It eases plugins discovery and simplifies the code to handle them,
+ IMHO, it's a fair trade-off.
+ """
+
+ @classmethod
+ def info(cls):
+ """self documenting class method
+ """
+ doc = 'Undocumented plugin! Fill "{}" docstring'.format(cls.__name__)
+ if cls.__doc__:
+ doc = cls.__doc__.strip(' \n').splitlines()[0]
+ return {'name': cls.__name__,
+ 'doc': doc,
+ }
-class Plugin():
def __init__(self, daemon):
+ self.log = daemon.log
self.__daemon = daemon
- #self.history = daemon.player.history
+ self.player = daemon.player
+ self.plugin_conf = None
+ self.__get_config()
+
+ def __str__(self):
+ return self.__class__.__name__
- @property
- def name(self):
- return self.__class__.__name__.lower()
+ def __get_config(self):
+ """Get plugin's specific configuration from global applications's config
+ """
+ conf = self.__daemon.config
+ for sec in conf.sections():
+ if sec == self.__class__.__name__.lower():
+ self.plugin_conf = conf[sec]
+ #if self.plugin_conf:
+ # self.log.debug('Got config for {0}: {1}'.format(self,
+ # self.plugin_conf))
+
+ def start(self):
+ """
+ Called when the daemon().run() is called and
+ right after the player has connected successfully.
+ """
+ pass
+
+ def callback_player(self):
+ """
+ Called on player changes, stopped, paused, skipped
+ """
+ pass
+
+ def callback_player_database(self):
+ """
+ Called on player music library changes
+ """
+ pass
def callback_playlist(self):
"""
def callback_next_song(self):
"""Not returning data,
- Could be use to scrobble
+ Could be use to scrobble, maintain an history…
"""
pass
- def callback_need_song(self):
+ def callback_need_track(self):
"""Returns a list of Track objects to add
"""
pass
- def callback_player_stop(self):
- """Not returning data,
- Could be use to ensure player never stops
+ def callback_need_track_fb(self):
+ """Called when callback_next_song failled to find tracks to queue
+ Returns a list of Track objects to add
"""
pass
def shutdown(self):
+ """Called on application shutdown"""
pass