src/com/android/phone/CallHandlerServiceProxy.java

/*
 * Copyright (C) 2013 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.phone;

import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Handler;
import android.os.IBinder;
import android.os.Message;
import android.os.RemoteException;
import android.os.SystemProperties;
import android.util.Log;

import com.android.phone.AudioRouter.AudioModeListener;
import com.android.services.telephony.common.AudioMode;
import com.android.services.telephony.common.Call;
import com.android.services.telephony.common.ICallHandlerService;
import com.google.common.collect.Lists;

import java.util.List;

/**
 * This class is responsible for passing through call state changes to the CallHandlerService.
 */
public class CallHandlerServiceProxy extends Handler
        implements CallModeler.Listener, AudioModeListener {

    private static final String TAG = CallHandlerServiceProxy.class.getSimpleName();
    private static final boolean DBG = (PhoneGlobals.DBG_LEVEL >= 1) && (SystemProperties.getInt(
            "ro.debuggable", 0) == 1);

    public static final int RETRY_DELAY_MILLIS = 2000;
    private static final int BIND_RETRY_MSG = 1;
    private static final int MAX_RETRY_COUNT = 5;

    private AudioRouter mAudioRouter;
    private CallCommandService mCallCommandService;
    private CallModeler mCallModeler;
    private Context mContext;
    private ICallHandlerService mCallHandlerServiceGuarded;  // Guarded by mServiceAndQueueLock
    private List<Call> mIncomingCallQueueGuarded;            // Guarded by mServiceAndQueueLock
    private List<List<Call>> mUpdateCallQueueGuarded;        // Guarded by mServiceAndQueueLock
    private List<Call> mDisconnectCallQueueGuarded;        // Guarded by mServiceAndQueueLock
    private final Object mServiceAndQueueLock = new Object();
    private int mBindRetryCount = 0;

    @Override
    public void handleMessage(Message msg) {
        super.handleMessage(msg);

        switch (msg.what) {
            case BIND_RETRY_MSG:
                setupServiceConnection();
                break;
        }
    }

    public CallHandlerServiceProxy(Context context, CallModeler callModeler,
            CallCommandService callCommandService, AudioRouter audioRouter) {
        if (DBG) {
            Log.d(TAG, "init CallHandlerServiceProxy");
        }
        mContext = context;
        mCallCommandService = callCommandService;
        mCallModeler = callModeler;
        mAudioRouter = audioRouter;

        mAudioRouter.addAudioModeListener(this);
        mCallModeler.addListener(this);

        if (PhoneGlobals.sVoiceCapable) {
            setupServiceConnection();
        }
    }

    @Override
    public void onDisconnect(Call call) {
        try {
            synchronized (mServiceAndQueueLock) {
                if (mCallHandlerServiceGuarded == null) {
                    if (DBG) {
                        Log.d(TAG, "CallHandlerService not connected.  Enqueue disconnect");
                    }
                    enqueueDisconnect(call);
                    return;
                }
            }
            if (DBG) {
                Log.d(TAG, "onDisconnect: " + call);
            }
            mCallHandlerServiceGuarded.onDisconnect(call);
        } catch (Exception e) {
            Log.e(TAG, "Remote exception handling onDisconnect ", e);
        }
    }

    @Override
    public void onIncoming(Call call) {
        try {
            synchronized (mServiceAndQueueLock) {
                if (mCallHandlerServiceGuarded == null) {
                    if (DBG) {
                        Log.d(TAG, "CallHandlerService not connected.  Enqueue incoming.");
                    }
                    enqueueIncoming(call);
                    return;
                }
            }
            if (DBG) {
                Log.d(TAG, "onIncoming: " + call);
            }
            // TODO(klp): check RespondViaSmsManager.allowRespondViaSmsForCall()
            // must refactor call method to accept proper call object.
            mCallHandlerServiceGuarded.onIncoming(call,
                    RejectWithTextMessageManager.loadCannedResponses());
        } catch (Exception e) {
            Log.e(TAG, "Remote exception handling onUpdate", e);
        }
    }

    @Override
    public void onUpdate(List<Call> calls) {
        try {
            synchronized (mServiceAndQueueLock) {
                if (mCallHandlerServiceGuarded == null) {
                    if (DBG) {
                        Log.d(TAG, "CallHandlerService not connected.  Enqueue update.");
                    }
                    enqueueUpdate(calls);
                    return;
                }
            }

            if (DBG) {
                Log.d(TAG, "onUpdate: " + calls.toString());
            }
            mCallHandlerServiceGuarded.onUpdate(calls);
        } catch (Exception e) {
            Log.e(TAG, "Remote exception handling onUpdate", e);
        }
    }

    @Override
    public void onAudioModeChange(int previousMode, int newMode) {
        try {
            synchronized (mServiceAndQueueLock) {
                // TODO(klp): does this need to be enqueued?
                if (mCallHandlerServiceGuarded == null) {
                    if (DBG) {
                        Log.d(TAG, "CallHandlerService not conneccted. Skipping "
                                + "onAudioModeChange().");
                    }
                    return;
                }
            }

            // Just do a simple log for now.
            Log.i(TAG, "Updating with new audio mode: " + AudioMode.toString(newMode) +
                    " from " + AudioMode.toString(previousMode));

            if (DBG) {
                Log.d(TAG, "onSupportAudioModeChange");
            }

            mCallHandlerServiceGuarded.onAudioModeChange(newMode);
        } catch (Exception e) {
            Log.e(TAG, "Remote exception handling onAudioModeChange", e);
        }
    }

    @Override
    public void onSupportedAudioModeChange(int modeMask) {
        try {
            synchronized (mServiceAndQueueLock) {
                // TODO(klp): does this need to be enqueued?
                if (mCallHandlerServiceGuarded == null) {
                    if (DBG) {
                        Log.d(TAG, "CallHandlerService not conneccted. Skipping"
                                + "onSupportedAudioModeChange().");
                    }
                    return;
                }
            }

            if (DBG) {
                Log.d(TAG, "onSupportAudioModeChange: " + AudioMode.toString(modeMask));
            }

            mCallHandlerServiceGuarded.onSupportedAudioModeChange(modeMask);
        } catch (Exception e) {
            Log.e(TAG, "Remote exception handling onAudioModeChange", e);
        }

    }

    private ServiceConnection mConnection = new ServiceConnection() {
        @Override public void onServiceConnected (ComponentName className, IBinder service){
            if (DBG) {
                Log.d(TAG, "Service Connected");
            }
            onCallHandlerServiceConnected(ICallHandlerService.Stub.asInterface(service));
        }

        @Override public void onServiceDisconnected (ComponentName className){
            Log.i(TAG, "Disconnected from UI service.");
            synchronized (mServiceAndQueueLock) {
                mCallHandlerServiceGuarded = null;

                // Technically, unbindService is un-necessary since the framework will schedule and
                // restart the crashed service.  But there is a exponential backoff for the restart.
                // Unbind explicitly and setup again to avoid the backoff since it's important to
                // always have an in call ui.
                mContext.unbindService(mConnection);
                setupServiceConnection();
            }
        }
    };

    public void bringToForeground() {
        // only support this call if the service is already connected.
        synchronized (mServiceAndQueueLock) {
            if (mCallHandlerServiceGuarded != null && mCallModeler.hasLiveCall()) {
                try {
                    if (DBG) Log.d(TAG, "bringToForeground");
                    mCallHandlerServiceGuarded.bringToForeground();
                } catch (RemoteException e) {
                    Log.e(TAG, "Exception handling bringToForeground", e);
                }
            }
        }
    }

    /**
     * Sets up the connection with ICallHandlerService
     */
    private void setupServiceConnection() {
        synchronized (mServiceAndQueueLock) {
            if (mCallHandlerServiceGuarded == null) {
                final Intent serviceIntent = new Intent(ICallHandlerService.class.getName());
                final ComponentName component = new ComponentName(mContext.getResources().getString(
                        R.string.incall_ui_default_package), mContext.getResources().getString(
                        R.string.incall_ui_default_class));
                serviceIntent.setComponent(component);

                if (DBG) {
                    Log.d(TAG, "binding to service " + serviceIntent);
                }
                if (!mContext.bindService(serviceIntent, mConnection, Context.BIND_AUTO_CREATE)) {
                    // This happens when the in-call package is in the middle of being installed.
                    // Delay the retry.
                    mBindRetryCount++;
                    if (mBindRetryCount < MAX_RETRY_COUNT) {
                        Log.e(TAG, "bindService failed on " + serviceIntent + ".  Retrying in " +
                                RETRY_DELAY_MILLIS + " ms.");
                        sendMessageDelayed(Message.obtain(this, BIND_RETRY_MSG),
                                RETRY_DELAY_MILLIS);
                    } else {
                        Log.wtf(TAG, "Tried to bind to in-call UI " + MAX_RETRY_COUNT + " times."
                                + " Giving up.");
                    }
                }
            }
        }
    }

    /**
     * Called when the in-call UI service is connected.  Send command interface to in-call.
     */
    private void onCallHandlerServiceConnected(ICallHandlerService callHandlerService) {
        synchronized (mServiceAndQueueLock) {
            mCallHandlerServiceGuarded = callHandlerService;

            // Before we send any updates, we need to set up the initial service calls.
            makeInitialServiceCalls();

            // TODO(klp): combine queues into a single ordered queue.
            processIncomingCallQueue();
            processUpdateCallQueue();
            processDisconnectQueue();
        }
    }

    /**
     * Makes initial service calls to set up callcommandservice and audio modes.
     */
    private void makeInitialServiceCalls() {
        try {
            mCallHandlerServiceGuarded.setCallCommandService(mCallCommandService);

            onSupportedAudioModeChange(mAudioRouter.getSupportedAudioModes());
            final int mode = mAudioRouter.getAudioMode();
            onAudioModeChange(mode, mode);
        } catch (RemoteException e) {
            Log.e(TAG, "Remote exception calling CallHandlerService::setCallCommandService", e);
        }
    }


    private void enqueueDisconnect(Call call) {
        if (mDisconnectCallQueueGuarded == null) {
            mDisconnectCallQueueGuarded = Lists.newArrayList();
        }
        mDisconnectCallQueueGuarded.add(new Call(call));
    }

    private void enqueueIncoming(Call call) {
        if (mIncomingCallQueueGuarded == null) {
            mIncomingCallQueueGuarded = Lists.newArrayList();
        }
        mIncomingCallQueueGuarded.add(new Call(call));
    }

    private void enqueueUpdate(List<Call> calls) {
        if (mUpdateCallQueueGuarded == null) {
            mUpdateCallQueueGuarded = Lists.newArrayList();
        }
        final List<Call> copy = Lists.newArrayList();
        for (Call call : calls) {
            copy.add(new Call(call));
        }
        mUpdateCallQueueGuarded.add(copy);
    }

    private void processDisconnectQueue() {
        if (mDisconnectCallQueueGuarded != null) {
            for (Call call : mDisconnectCallQueueGuarded) {
                onDisconnect(call);
            }
            mDisconnectCallQueueGuarded.clear();
            mDisconnectCallQueueGuarded = null;
        }
    }

    private void processIncomingCallQueue() {
        if (mIncomingCallQueueGuarded != null) {
            for (Call call : mIncomingCallQueueGuarded) {
                onIncoming(call);
            }
            mIncomingCallQueueGuarded.clear();
            mIncomingCallQueueGuarded = null;
        }
    }

    private void processUpdateCallQueue() {
        if (mUpdateCallQueueGuarded != null) {
            for (List<Call> calls : mUpdateCallQueueGuarded) {
                onUpdate(calls);
            }
            mUpdateCallQueueGuarded.clear();
            mUpdateCallQueueGuarded = null;
        }
    }
}