Add dbus media source plugin

Change-Id: I5eb65ec17afb299e231d061c48ba5cfd4eb1ecb6
Reviewed-on: http://gerrit.dmdirc.com/280
Reviewed-by: Shane Mc Cormack <shane@dmdirc.com>
Tested-by: Gregory Holmes <greboid@dmdirc.com>

src/com/dmdirc/addons/mediasource_dbus/BansheeSource.java

@@ -0,0 +1,175 @@
+/*
+ * Copyright (c) 2006-2010 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.mediasource_dbus;
+
+import com.dmdirc.addons.nowplaying.MediaSource;
+import com.dmdirc.addons.nowplaying.MediaSourceState;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A media source for Banshee.
+ *
+ * @author chris
+ */
+public class BansheeSource implements MediaSource {
+
+    /** The dbus service name. */
+    private static final String SERVICE = "org.bansheeproject.Banshee";
+    /** The dbus interface name. */
+    private static final String IFACE = "/org/bansheeproject/Banshee/PlayerEngine";
+    /** The method to get the current state. */
+    private static final String STATE = "org.bansheeproject.Banshee.PlayerEngine.GetCurrentState";
+    /** The method to get the current track. */
+    private static final String TRACK = "org.bansheeproject.Banshee.PlayerEngine.GetCurrentTrack";
+    /** The method to get the current position. */
+    private static final String POSITION = "org.bansheeproject.Banshee.PlayerEngine.GetPosition";
+
+    /** The media source that owns this source. */
+    private final DBusMediaSource source;
+    /** A cache of track information. */
+    private Map<String, String> trackInfo;
+
+    public BansheeSource(final DBusMediaSource source) {
+        this.source = source;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public MediaSourceState getState() {
+        final List<String> res = source.doDBusCall(SERVICE, IFACE, STATE);
+        
+        if (res.isEmpty()) {
+            trackInfo = null;
+            return MediaSourceState.CLOSED;
+        } else if ("playing".equals(res.get(0))) {
+            trackInfo = getTrackInfo();
+            return MediaSourceState.PLAYING;
+        } else if ("paused".equals(res.get(0))) {
+            trackInfo = getTrackInfo();
+            return MediaSourceState.PAUSED;
+        } else if ("idle".equals(res.get(0))) {
+            trackInfo = getTrackInfo();
+            return MediaSourceState.STOPPED;
+        } else {
+            trackInfo = null;
+            return MediaSourceState.NOTKNOWN;
+        }
+    }
+
+    /**
+     * Retrieves a map of track information from the dbus service.
+     *
+     * @return A map of track information
+     */
+    protected Map<String, String> getTrackInfo() {
+        return DBusMediaSource.parseDictionary(source.doDBusCall(SERVICE, IFACE, TRACK));
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getAppName() {
+        return "Banshee";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getArtist() {
+        return trackInfo == null ? "Unknown" : trackInfo.get("artist");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getTitle() {
+        return trackInfo == null ? "Unknown" : trackInfo.get("name");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getAlbum() {
+        return trackInfo == null ? "Unknown" : trackInfo.get("album");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getLength() {
+        return trackInfo == null ? "Unknown" : duration((long)
+                Double.parseDouble(trackInfo.get("length")));
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getTime() {
+        return duration((long) Double.parseDouble(source.doDBusCall(SERVICE,
+                IFACE, POSITION).get(0)) / 1000);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getFormat() {
+        return trackInfo == null ? "Unknown" : trackInfo.get("mime-type");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getBitrate() {
+        return trackInfo == null ? "Unknown" : trackInfo.get("bit-rate");
+    }
+
+    /**
+     * Get the duration in seconds as a string.
+     *
+     * @param seconds Input to get duration for
+     * @return Duration as a string
+     */
+    private String duration(final long secondsInput) {
+        final StringBuilder result = new StringBuilder();
+        final long hours = secondsInput / 3600;
+        final long minutes = secondsInput / 60 % 60;
+        final long seconds = secondsInput % 60;
+
+        if (hours > 0) {
+            if (hours < 10) {
+                result.append('0');
+            }
+
+            result.append(hours).append(":");
+        }
+
+        if (minutes < 10) {
+            result.append('0');
+        }
+
+        result.append(minutes).append(":");
+
+        if (seconds < 10) {
+            result.append('0');
+        }
+
+        result.append(seconds);
+
+        return result.toString();
+    }
+
+}

src/com/dmdirc/addons/mediasource_dbus/DBusMediaSource.java

@@ -0,0 +1,177 @@
+/*
+ * Copyright (c) 2006-2010 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.mediasource_dbus;
+
+import com.dmdirc.addons.nowplaying.MediaSource;
+import com.dmdirc.addons.nowplaying.MediaSourceManager;
+import com.dmdirc.plugins.Plugin;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Provides a media source for dbus players.
+ */
+public class DBusMediaSource extends Plugin implements MediaSourceManager {
+
+    /** The sources used by this media source. */
+    private List<MediaSource> sources;
+    /** A map of discovered mpris sources. */
+    private final Map<String, MediaSource> mprisSources = new HashMap<String, MediaSource>();
+    /** The path to qdbus. */
+    private String qdbus;
+       
+    /**
+     * Creates a new instance of DBusMediaSource.
+     */
+    public DBusMediaSource() {
+        super();
+    }
+    
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        sources = new ArrayList<MediaSource>(Arrays.asList(new MediaSource[]{
+            new BansheeSource(this),
+        }));
+
+        if (new File("/usr/bin/qdbus").exists()) {
+            qdbus = "/usr/bin/qdbus";
+        } else if (new File("/bin/qdbus").exists()) {
+            qdbus = "/bin/qdbus";
+        }
+    }
+    
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public List<MediaSource> getSources() {
+        for (String mpris : doDBusCall("org.mpris.*", "/", "/")) {
+            final String service = mpris.substring(10);
+
+            if (!mprisSources.containsKey(service)) {
+                mprisSources.put(service, new MPRISSource(this, service));
+                sources.add(mprisSources.get(service));
+            }
+        }
+
+        return sources;
+    }
+
+    /**
+     * Performs a dbus call.
+     *
+     * @param service The name of the service
+     * @param iface The name of the interface
+     * @param method The name of the method
+     * @param args Any arguments to the method
+     * @return A list of output (one entry per line)
+     */
+    public List<String> doDBusCall(final String service, final String iface,
+            final String method, final String ... args) {
+        final String[] exeArgs = new String[4 + args.length];
+        exeArgs[0] = qdbus;
+        exeArgs[1] = service;
+        exeArgs[2] = iface;
+        exeArgs[3] = method;
+
+        for (int i = 0; i < args.length; i++) {
+            exeArgs[4 + i] = args[i];
+        }
+
+        return getInfo(exeArgs);
+    }
+
+    /**
+     * Executes the specified command and arguments and returns the results.
+     *
+     * @param args The command/arguments to be executed
+     * @return The output of the specified command
+     */
+    protected static List<String> getInfo(final String[] args) {
+        final ArrayList<String> result = new ArrayList<String>();
+
+        InputStreamReader reader;
+        BufferedReader input;
+        Process process;
+
+        try {
+            process = Runtime.getRuntime().exec(args);
+
+            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) {
+            ex.printStackTrace();
+        }
+
+        return result;
+    }
+
+    /**
+     * Parses a dbus dictionary into a {@link Map}.
+     *
+     * @param lines The lines to be parsed as a dictionary
+     * @return A map corresponding to the specified dictionary
+     */
+    protected static Map<String, String> parseDictionary(final List<String> lines) {
+        final Map<String, String> res = new HashMap<String, String>();
+
+        for (String line : lines) {
+            final int index = line.indexOf(':');
+
+            if (index == -1 || index >= line.length() - 2) {
+                continue;
+            }
+            
+            final String key = line.substring(0, index);
+            final String value = line.substring(index + 2);
+
+            res.put(key, value);
+        }
+
+        return res;
+    }
+
+}

src/com/dmdirc/addons/mediasource_dbus/MPRISSource.java

@@ -0,0 +1,193 @@
+/*
+ * Copyright (c) 2006-2010 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.mediasource_dbus;
+
+import com.dmdirc.addons.nowplaying.MediaSource;
+import com.dmdirc.addons.nowplaying.MediaSourceState;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A media source for anything that's compatible with MRPIS.
+ *
+ * @author chris
+ */
+public class MPRISSource implements MediaSource {
+
+    /** The media source manager. */
+    private final DBusMediaSource source;
+    /** The service name. */
+    private final String service;
+    /** The name of the source. */
+    private final String name;
+    /** A temporary cache of track data. */
+    private Map<String, String> data;
+
+    /**
+     * Creates a new MPRIS source for the specified service name.
+     *
+     * @param source The manager which owns this source
+     * @param service The service name of the MRPIS service
+     */
+    public MPRISSource(final DBusMediaSource source, final String service) {
+        this.source = source;
+        this.service = service;
+
+        this.name = source.doDBusCall("org.mpris." + service, "/",
+                "org.freedesktop.MediaPlayer.Identity").get(0).replace(' ', '_');
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public MediaSourceState getState() {
+        final char[] status = getStatus();
+
+        if (status == null) {
+            data = null;
+            return MediaSourceState.CLOSED;
+        }
+
+        data = getTrackInfo();
+
+        if (status[0] == '0') {
+            return MediaSourceState.PLAYING;
+        } else if (status[0] == '1') {
+            return MediaSourceState.PAUSED;
+        } else if (status[0] == '2') {
+            return MediaSourceState.STOPPED;
+        } else {
+            return MediaSourceState.NOTKNOWN;
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getAppName() {
+        return name;
+    }
+
+    /**
+     * Utility method to return the value of the specified key if it exists,
+     * or "Unknown" if it doesn't.
+     *
+     * @param key The key to be retrieved
+     * @return The value of the specified key or "Unknown".
+     */
+    protected String getData(final String key) {
+        return data == null || !data.containsKey(key) ? "Unknown" : data.get(key);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getArtist() {
+        return getData("artist");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getTitle() {
+        return getData("title");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getAlbum() {
+        return getData("album");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getLength() {
+        return getData("time");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getTime() {
+        return "Unknown";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getFormat() {
+        return "Unknown";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getBitrate() {
+        return getData("audio-bitrate");
+    }
+
+    /**
+     * Retrieves a map of track information from the service.
+     *
+     * @return A map of metadata returned by the MPRIS service
+     */
+    protected Map<String, String> getTrackInfo() {
+        // If only there were a standard...
+        final List<String> list = source.doDBusCall("org.mpris." + service,
+                "/Player", "org.freedesktop.MediaPlayer.GetMetadata");
+        list.addAll(source.doDBusCall("org.mpris." + service,
+                "/Player", "org.freedesktop.MediaPlayer.GetMetaData"));
+        return DBusMediaSource.parseDictionary(list);
+    }
+
+    /**
+     * Retrieves the 'status' result from the MPRIS service.
+     *
+     * @return The returned status or null if the service isn't running
+     */
+    protected char[] getStatus() {
+        if (source.doDBusCall("org.mpris." + service, "/",
+                "org.freedesktop.MediaPlayer.Identity").isEmpty()) {
+            // Calling dbus-send can seemingly start applications that have
+            // quit (not entirely sure how), so check that it's running first.
+            return null;
+        }
+
+        final List<String> res = DBusMediaSource.getInfo(new String[]{
+            "/usr/bin/dbus-send", "--print-reply", "--dest=org.mpris." + service,
+            "/Player", "org.freedesktop.MediaPlayer.GetStatus"
+        });
+
+        if (res.isEmpty()) {
+            return null;
+        }
+
+        final char[] result = new char[4];
+        int i = 0;
+
+        for (String line : res) {
+            final String tline = line.trim();
+
+            if (tline.startsWith("int32")) {
+                result[i++] = tline.charAt(tline.length() - 1);
+            }
+        }
+
+        return result;
+    }
+
+}

src/com/dmdirc/addons/mediasource_dbus/plugin.config

@@ -0,0 +1,34 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  updates
+  version
+  requires
+
+metadata:
+  author=Chris <chris@dmdirc.com>
+  mainclass=com.dmdirc.addons.mediasource_dbus.DBusMediaSource
+  description=Provides a media source for dbus-enabled clients
+  name=dbusmediasource
+  nicename=DBus Media Source
+
+updates:
+  id=39
+
+version:
+  friendly=1.0
+
+provides:
+  banshee mediasource
+  mpris mediasource
+
+requires:
+  os=linux
+  files=/usr/bin/qdbus|/bin/qdbus
+
+required-services:
+  mediasource manager