ProviderConnection.java

/*
 * Copyright (C) 2014 Fastboot Mobile, LLC.
 *
 * This program 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.
 *
 * This program 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 this program;
 * if not, see <http://www.gnu.org/licenses>.
 */

package com.fastbootmobile.encore.providers;

import android.content.ComponentName;
import android.content.Context;
import android.os.DeadObjectException;
import android.os.IBinder;
import android.os.Looper;
import android.os.RemoteException;
import android.util.Log;

import com.fastbootmobile.encore.service.NativeHub;

/**
 * Represents a connection to an audio provider (music source) service
 */
public class ProviderConnection extends AbstractProviderConnection
        implements AudioHostSocket.AudioHostSocketListener,
        Comparable<ProviderConnection> {
    private static final String TAG = "ProviderConnection";

    // Don't ship with this set to false
    private static final boolean ALLOW_BINDER_ON_UI_THREAD = true;

    private IMusicProvider mBinder;

    /**
     * Constructor
     *
     * @param ctx            The context to which this connection should be bound
     * @param providerName   The name of the provider (example: 'Spotify')
     * @param pkg            The package in which the service can be found (example: org.example.music)
     * @param serviceName    The name of the service (example: .MusicService)
     * @param configActivity The name of the configuration activity in the aforementioned package
     */
    public ProviderConnection(Context ctx, String providerName, String authorName, String pkg,
                              String serviceName, String configActivity) {
        super(ctx, providerName, authorName, pkg, serviceName, configActivity);

        // Try to bind to the service
        bindService();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void unbindService(NativeHub hub) {
        if (mIsBound) {
            ProviderAggregator.getDefault().unregisterProvider(this);
            if (mAudioSocketName != null) {
                hub.releaseHostSocket(mAudioSocketName);
                mAudioSocketName = null;
            }

            mBinder = null;
        }

        super.unbindService(hub);
    }

    /**
     * This is the same as getBinder(true)
     * @return The binder of the provider
     */
    public IMusicProvider getBinder() {
        return getBinder(true);
    }

    /**
     * Returns the binder for this provider
     * @param willCall If true, indicates calls will be made to this provider, allowing checking
     *                 if the binder will be used in the main thread
     * @return The binder of the provider
     */
    public IMusicProvider getBinder(boolean willCall) {
        if (!ALLOW_BINDER_ON_UI_THREAD && willCall &&
                Thread.currentThread().equals(Looper.getMainLooper().getThread())) {
            throw new RuntimeException("Binder call on UI thread");
        }
        return mBinder;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onServiceConnected(ComponentName name, IBinder service) {
        mBinder = IMusicProvider.Stub.asInterface(service);

        try {
            // Tell the provider its identifier
            mBinder.setIdentifier(mIdentifier);

            // Register the provider
            ProviderAggregator.getDefault().registerProvider(this);
            mIsBound = true;
            if (DEBUG) Log.d(TAG, "Connected to providers " + name);

            // Automatically try to login the providers once bound
            if (mBinder.isSetup()) {
                if (DEBUG) Log.d(TAG, "Provider " + getProviderName() + " is setup! Trying to see if auth");
                if (!mBinder.isAuthenticated()) {
                    if (!mBinder.login()) {
                        Log.e(TAG, "Error while requesting login!");
                    }
                } else {
                    // Update playlists
                    ProviderAggregator.getDefault().getAllPlaylists();
                }
            }

            if (mAudioSocketName != null) {
                mBinder.setAudioSocketName(mAudioSocketName);
            }
        } catch (RemoteException e) {
            Log.e(TAG, "Remote exception occurred on the set providers", e);
        }

        super.onServiceConnected(name, service);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onServiceDisconnected(ComponentName name) {
        // Release the binder
        mBinder = null;
        super.onServiceDisconnected(name);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean createAudioSocket(final NativeHub hub, final String socketName) {
        if (super.createAudioSocket(hub, socketName)) {
            if (mBinder != null) {
                try {
                    mBinder.setAudioSocketName(socketName);
                } catch (DeadObjectException e) {
                    Log.e(TAG, "Provider died while assigning audio socket to " + getProviderName(), e);
                } catch (Exception e) {
                    Log.e(TAG, "Cannot assign audio socket to " + getProviderName(), e);
                }
            }
            return true;
        } else {
            return false;
        }
    }

    @Override
    public void onSocketError() {
        // Socket got killed. If we're still bound to this service, recreate a new socket and
        // assign it.
        // TODO: Is this still needed?
        Log.e(TAG, "Socket error");
    }

    @Override
    public int compareTo(ProviderConnection o) {
        return getServiceName().compareTo(o.getServiceName());
    }
}