DMDirc-Plugins/mediasource_dbus/src/main/java/com/dmdirc/addons/mediasource_dbus/DBusMediaSourceManager.java

/*
 * Copyright (c) 2006-2017 DMDirc Developers
 *
 * 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 java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.inject.Inject;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.dmdirc.util.LogUtils.USER_ERROR;

/**
 * Provides a media source for DBUS players.
 */
public class DBusMediaSourceManager {

    private static final Logger LOG = LoggerFactory.getLogger(DBusMediaSourceManager.class);
    /** A map of discovered mpris sources. */
    private final Map<String, MediaSource> mprisSources;
    /** The sources used by this media source. */
    private final List<MediaSource> sources;
    /** The path to qdbus. */
    private String qdbus;

    @Inject
    public DBusMediaSourceManager() {
        sources = new ArrayList<>();
        mprisSources = new HashMap<>();
    }

    /**
     * Called when the plugin is loaded to initialise settings.
     */
    public void onLoad() {
        if (new File("/usr/bin/qdbus").exists()) {
            qdbus = "/usr/bin/qdbus";
        } else if (new File("/bin/qdbus").exists()) {
            qdbus = "/bin/qdbus";
        }
    }

    /**
     * Called when the plugin is unloaded to uninitialise settings.
     */
    public void onUnload() {
        sources.clear();
        mprisSources.clear();
    }

    /**
     * Returns the source again for this plugin.
     *
     * @return List of available MPRIS media sources.
     */
    public List<MediaSource> getSources() {
        for (String mpris : doDBusCall("org.mpris.*", "/", "/")) {
            try {
                final String service = mpris.substring(10);

                if (!mprisSources.containsKey(service)) {
                    mprisSources.put(service, new MPRISSource(this, service));
                    sources.add(mprisSources.get(service));
                }
            } catch (IllegalArgumentException ex) {
                // The service either stopped after the initial call and before
                // we created an MRPIS Source, or otherwise doesn't correctly
                // implement MPRIS. Either way, ignore it.
            }
        }

        return Collections.unmodifiableList(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;

        System.arraycopy(args, 0, exeArgs, 4, args.length);

        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 List<String> getInfo(final String... args) {
        final List<String> result = new ArrayList<>();
        Process process = null;
        try {
            process = Runtime.getRuntime().exec(args);
            try (InputStreamReader reader = new InputStreamReader(process.getInputStream());
                    BufferedReader input = new BufferedReader(reader)){
                String line;
                while ((line = input.readLine()) != null) {
                    result.add(line);
                }
            }
        } catch (IOException ex) {
            LOG.error(USER_ERROR, "Unable to get DBUS info", ex);
        } finally {
            if (process != null) {
                process.destroy();
            }
        }

        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 Map<String, String> parseDictionary(final Iterable<String> lines) {
        final Map<String, String> res = new HashMap<>();

        for (String line : lines) {
            final int index = line.indexOf(':', line.indexOf(':') + 1);

            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;
    }
}