From 80162143f725cbe604f7241e4dfc4929833470e5 Mon Sep 17 00:00:00 2001
From: kaliko <kaliko@azylum.org>
Date: Tue, 21 Nov 2017 15:12:33 +0100
Subject: [PATCH] Enhanced queuing behavior in random mode (Closes #16)

---
 doc/Changelog                   |  4 ++--
 sima/client.py                  | 12 ++++++++++++
 sima/core.py                    |  8 ++++++--
 sima/lib/player.py              | 15 +++++++++++++++
 sima/lib/webserv.py             | 19 ++++++++++++++++---
 sima/plugins/core/mpdoptions.py |  4 ++--
 6 files changed, 53 insertions(+), 9 deletions(-)

diff --git a/doc/Changelog b/doc/Changelog
index 4b8e8ae..4d9b23d 100644
--- a/doc/Changelog
+++ b/doc/Changelog
@@ -1,6 +1,6 @@
-MPD_sima v0.14.5
+MPD_sima v0.15.0
 
- * …
+ * Enhanced queuing behavior in random mode (Closes #16)
 
 -- kaliko jack <kaliko@azylum.org> UNRELEASED
 
diff --git a/sima/client.py b/sima/client.py
index 525f268..c04f560 100644
--- a/sima/client.py
+++ b/sima/client.py
@@ -339,6 +339,18 @@ class PlayerClient(Player):
     def state(self):
         return str(self.status().get('state'))
 
+    @property
+    def playmode(self):
+        plm = {'repeat': None,
+               'single': None,
+               'random': None,
+               'consume': None,
+              }
+        for key, val in self.status().items():
+            if key in plm.keys():
+                plm.update({key:bool(int(val))})
+        return plm
+
     @property
     def current(self):
         return self.currentsong()
diff --git a/sima/core.py b/sima/core.py
index eea108d..ce1b078 100644
--- a/sima/core.py
+++ b/sima/core.py
@@ -93,9 +93,13 @@ class Sima(Daemon):
         if not self.enabled:
             self.log.debug('Queueing disabled!')
             return False
-        queue = self.player.queue
         queue_trigger = self.config.getint('sima', 'queue_length')
-        self.log.debug('Currently %s track(s) ahead. (target %s)', len(queue), queue_trigger)
+        if self.player.playmode.get('random'):
+            queue = self.player.playlist
+            self.log.debug('Currently %s track(s) in the playlist. (target %s)', len(queue), queue_trigger)
+        else:
+            queue = self.player.queue
+            self.log.debug('Currently %s track(s) ahead. (target %s)', len(queue), queue_trigger)
         if len(queue) < queue_trigger:
             return True
         return False
diff --git a/sima/lib/player.py b/sima/lib/player.py
index 721d9a6..1d1f693 100644
--- a/sima/lib/player.py
+++ b/sima/lib/player.py
@@ -152,6 +152,21 @@ class Player(object):
 
     @property
     def state(self):
+        """Returns (play|stop|pause)"""
+        #pylint: disable=C0111
+        raise NotImplementedError
+
+    @property
+    def playmode(self):
+        """Returns a mapping
+        {
+            'repeat': boolean,
+            'random': boolean,
+            'single': boolean,
+            'consume': boolean,
+            …
+            }
+        """
         #pylint: disable=C0111
         raise NotImplementedError
 
diff --git a/sima/lib/webserv.py b/sima/lib/webserv.py
index 50d2b81..cd28128 100644
--- a/sima/lib/webserv.py
+++ b/sima/lib/webserv.py
@@ -112,7 +112,10 @@ class WebService(Plugin):
             * not blacklisted
         """
         artist = tracks[0].artist
-        black_list = self.player.queue + self.to_add
+        if self.player.playmode.get('random'):
+            black_list = self.player.playlist + self.to_add
+        else:
+            black_list = self.player.queue + self.to_add
         not_in_hist = list(set(tracks) - set(self.get_history(artist=artist)))
         if self.plugin_conf.get('queue_mode') != 'top' and not not_in_hist:
             self.log.debug('All tracks already played for "%s"', artist)
@@ -195,7 +198,10 @@ class WebService(Plugin):
         if not self.player.playlist:
             return
         history = list(self.history)
-        history = self.player.queue + history
+        if self.player.playmode.get('random'):
+            history = self.player.playlist + history
+        else:
+            history = self.player.queue + history
         history = deque(history)
         last_trk = history.popleft() # remove
         extra_arts = list()
@@ -266,7 +272,10 @@ class WebService(Plugin):
         if not ret:
             self.log.warning('Got nothing from music library.')
             return []
-        queued_artists = MetaContainer([trk.Artist for trk in self.player.queue])
+        if self.player.playmode.get('random'):
+            queued_artists = MetaContainer([trk.Artist for trk in self.player.playlist])
+        else:
+            queued_artists = MetaContainer([trk.Artist for trk in self.player.queue])
         self.log.trace('Already queued: {}'.format(queued_artists))
         self.log.trace('Candidate: {}'.format(ret))
         if ret & queued_artists:
@@ -324,6 +333,10 @@ class WebService(Plugin):
                 if tracks[0] in self.player.queue:
                     self.log.debug('"%s" already queued, skipping!', tracks[0].album)
                     continue
+                if tracks[0] in self.player.playlist:
+                    if self.player.playmode.get('random'):
+                        self.log.debug('"%s" already in playlist, skipping!', tracks[0].album)
+                        continue
                 album_to_queue = album
             if not album_to_queue:
                 self.log.info('No album found for "%s"', artist)
diff --git a/sima/plugins/core/mpdoptions.py b/sima/plugins/core/mpdoptions.py
index ab5a4cb..fe368bd 100644
--- a/sima/plugins/core/mpdoptions.py
+++ b/sima/plugins/core/mpdoptions.py
@@ -43,10 +43,10 @@ class MpdOptions(Plugin):
         Called on player changes
         """
         player = self.daemon.player
-        if player.status().get('single') == str(1):
+        if player.playmode.get('single'):
             self.log.info('MPD "single" mode activated.')
             self.daemon.enabled = False
-        elif player.status().get('repeat') == str(1):
+        elif player.playmode.get('repeat'):
             self.log.info('MPD "repeat" mode activated.')
             self.daemon.enabled = False
         else:
-- 
2.39.5