Work on the nowplaying plugin

git-svn-id: http://svn.dmdirc.com/trunk@1569 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/addons/dcop/AmarokSource.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.dcop;
+
+import com.dmdirc.addons.nowplaying.MediaSource;
+
+/**
+ * Uses DCOP to retrieve now playing info from Amarok.
+ * 
+ * @author chris
+ */
+public class AmarokSource implements MediaSource {
+
+    /** {@inheritDoc} */
+    public boolean isRunning() {
+        final String result = DcopPlugin.getDcopResult("dcop amarok player isPlaying").get(0);
+        
+        return result.indexOf("failed") != -1;
+    }
+
+    /** {@inheritDoc} */
+    public boolean isPlaying() {
+        final String result = DcopPlugin.getDcopResult("dcop amarok player isPlaying").get(0);
+        
+        return Boolean.parseBoolean(result);
+    }
+
+    /** {@inheritDoc} */
+    public String getInformation() {       
+        return DcopPlugin.getDcopResult("dcop amarok player nowPlaying").get(0);
+    }
+
+    /** {@inheritDoc} */
+    public String getName() {
+        return "Amarok";
+    }
+    
+}

src/com/dmdirc/addons/dcop/DcopCommand.java

@@ -56,13 +56,9 @@ public final class DcopCommand extends ServerCommand {
      */
     public void execute(final InputWindow origin, final Server server,
             final boolean isSilent, final String... args) {
-        try {
-            final List<String> res = DcopPlugin.getDcopResult("dcop " + implodeArgs(args));
-            for (String line : res) {
-                sendLine(origin, isSilent, "commandOutput", line);
-            }
-        } catch (IOException ex) {
-            Logger.error(ErrorLevel.ERROR, "Unable to execute dcop", ex);
+        final List<String> res = DcopPlugin.getDcopResult("dcop " + implodeArgs(args));
+        for (String line : res) {
+            sendLine(origin, isSilent, "commandOutput", line);
         }
     }
     

src/com/dmdirc/addons/dcop/DcopPlugin.java

@@ -22,6 +22,8 @@
 
 package com.dmdirc.addons.dcop;
 
+import com.dmdirc.addons.nowplaying.MediaSource;
+import com.dmdirc.addons.nowplaying.MediaSourceManager;
 import com.dmdirc.plugins.Plugin;
 
 import java.io.BufferedReader;
@@ -32,31 +34,46 @@ import java.util.List;
 
 /**
  * Allows the user to execute dcop commands (and read the results).
+ * 
  * @author chris
  */
-public final class DcopPlugin extends Plugin {
+public final class DcopPlugin extends Plugin implements MediaSourceManager {
     
     /** Creates a new instance of DcopPlugin. */
     public DcopPlugin() {
-        
+        super();
     }
     
     /**
      * Retrieves the result from executing the specified command.
+     *
      * @param command The command to be executed
      * @return The output of the specified command
-     * @throws IOException on dcop failure
      */
-    public static List<String> getDcopResult(final String command) throws IOException {
+    public static List<String> getDcopResult(final String command) {
         final ArrayList<String> result = new ArrayList<String>();
+
+        InputStreamReader reader;
+        BufferedReader input;
+        Process process;
         
-        final Process process = Runtime.getRuntime().exec(command);
-        final BufferedReader input = new BufferedReader(new InputStreamReader(process.getInputStream()));
-        
-        String line = "";
-        
-        while ((line = input.readLine()) != null) {
-            result.add(line);
+        try {
+            process = Runtime.getRuntime().exec(command);
+            
+            reader = new InputStreamReader(process.getInputStream());
+            input = new BufferedReader(reader);
+            
+            String line = "";
+            
+            while ((line = input.readLine()) != null) {
+                result.add(line);
+            }
+            
+            reader.close();
+            input.close();
+            process.destroy();
+        } catch (IOException ex) {
+            // Do nothing
         }
         
         return result;
@@ -94,4 +111,13 @@ public final class DcopPlugin extends Plugin {
     public String toString() {
         return "DCOP Plugin";
     }
+
+    /** {@inheritDoc} */
+    public List<MediaSource> getSources() {
+        final ArrayList<MediaSource> res = new ArrayList<MediaSource>();
+        
+        res.add(new AmarokSource());
+        
+        return res;
+    }
 }

src/com/dmdirc/addons/dcop/NowPlayingCommand.java

@@ -56,20 +56,15 @@ public final class NowPlayingCommand extends ChannelCommand {
      * @param channel The channel object this command is associated with
      * @param isSilent Whether this command is silenced or not
      * @param args The user supplied arguments
-     */    
-    public void execute(final InputWindow origin, final Server server, 
+     */
+    public void execute(final InputWindow origin, final Server server,
             final Channel channel, final boolean isSilent, final String... args) {
-        try {
-            
-            final List<String> res = DcopPlugin.getDcopResult("dcop amarok default nowPlaying");
-            
-            channel.sendAction("is listening to " + res.get(0));
-            
-        } catch (IOException ex) {
-            Logger.error(ErrorLevel.ERROR, "Unable to execute dcop", ex);
-        }        
-    }
+        final List<String> res = DcopPlugin.getDcopResult("dcop amarok default nowPlaying");
         
+        channel.sendAction("is listening to " + res.get(0));
+        
+    }
+    
     
     
     /** {@inheritDoc}. */
@@ -96,5 +91,5 @@ public final class NowPlayingCommand extends ChannelCommand {
     public String getHelp() {
         return "nowplaying - tells the channel the song you're currently playing";
     }
-
+    
 }

src/com/dmdirc/addons/nowplaying/MediaSource.java

@@ -31,14 +31,14 @@ package com.dmdirc.addons.nowplaying;
 public interface MediaSource {
     
     /**
-     * Determine if the application for this source is running or not
+     * Determine if the application for this source is running or not.
      * 
      * @return True if this source is running, false otherwise
      */
     boolean isRunning();
     
     /**
-     * Determine if this source is currently playing or not
+     * Determine if this source is currently playing or not.
      * 
      * @return True if this source is playing, false otherwise
      */
@@ -51,5 +51,12 @@ public interface MediaSource {
      * @return The currently playing media
      */
     String getInformation();
+    
+    /**
+     * Retrieves the name of the application that this source is for.
+     * 
+     * @return This source's application name
+     */
+    String getName();
 
 }

src/com/dmdirc/addons/nowplaying/NowPlayingPlugin.java

@@ -0,0 +1,162 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.nowplaying;
+
+import com.dmdirc.actions.ActionType;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.plugins.EventPlugin;
+import com.dmdirc.plugins.Plugin;
+import com.dmdirc.plugins.PluginManager;
+import java.util.ArrayList;
+import java.util.List;
+
+public class NowPlayingPlugin extends Plugin implements EventPlugin {
+
+    /** The sources that we know of. */
+    private List<MediaSource> sources;
+
+    /** {@inheritDoc} */
+    public boolean onLoad() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    protected void onActivate() {
+        sources = new ArrayList<MediaSource>();
+        
+        for (Plugin target : PluginManager.getPluginManager().getPlugins()) {
+            if (target.isActive()) {
+                addPlugin(target);
+            }
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    protected void onDeactivate() {
+        sources = null;
+    }
+
+    /** {@inheritDoc} */
+    public String getVersion() {
+        return "0.1";
+    }
+
+    /** {@inheritDoc} */
+    public String getAuthor() {
+        return "Chris <chris@dmdirc.com>";
+    }
+
+    /** {@inheritDoc} */
+    public String getDescription() {
+        return "Adds a nowplaying command";
+    }
+
+    /** {@inheritDoc} */
+    public String toString() {
+        return "Now playing command";
+    }
+
+    /** {@inheritDoc} */
+    public void processEvent(ActionType type, StringBuffer format, Object... arguments) {
+        if (type == CoreActionType.PLUGIN_ACTIVATED) {
+            addPlugin((Plugin) arguments[0]);
+        } else if (type == CoreActionType.PLUGIN_DEACTIVATED) {
+            removePlugin((Plugin) arguments[0]);
+        }
+    }
+    
+    /**
+     * Checks to see if a plugin implements one of the Media Source interfaces
+     * and if it does, adds the source(s) to our list.
+     * 
+     * @param target The plugin to be tested
+     */
+    private void addPlugin(final Plugin target) {
+        if (target instanceof MediaSource) {
+            sources.add((MediaSource) target);
+        }
+        
+        if (target instanceof MediaSourceManager) {
+            sources.addAll(((MediaSourceManager) target).getSources());
+        }
+    }
+
+    /**
+     * Checks to see if a plugin implements one of the Media Source interfaces
+     * and if it does, removes the source(s) from our list.
+     * 
+     * @param target The plugin to be tested
+     */    
+    private void removePlugin(final Plugin target) {
+        if (target instanceof MediaSource) {
+            sources.remove((MediaSource) target);
+        }
+        
+        if (target instanceof MediaSourceManager) {
+            sources.removeAll(((MediaSourceManager) target).getSources());
+        }        
+    }
+    
+    /**
+     * Determines if there are any valid sources (paused or not).
+     * 
+     * @return True if there are running sources, false otherwise
+     */
+    public boolean hasRunningSource() {
+        for (MediaSource source : sources) {
+            if (source.isRunning()) {
+                return true;
+            }
+        }
+        
+        return false;
+    }
+    
+    /**
+     * Retrieves the "best" source to use for displaying media information.
+     * The best source is defined as the earliest in the list that is running
+     * and not paused, or, if no such source exists, the earliest in the list
+     * that is running and paused. If neither condition is satisified returns
+     * null.
+     * 
+     * @return The best source to use for media info
+     */
+    public MediaSource getBestSource() {
+        MediaSource paused = null;
+        
+        for (MediaSource source : sources) {
+            if (source.isRunning()) {
+                if (source.isPlaying()) {
+                    return source;
+                } else if (paused == null) {
+                    paused = source;
+                }
+            }
+        }
+        
+        return paused;
+    }
+    
+}