bluetooth/pbap/BluetoothPbapService.java

/*
 * Copyright (c) 2008-2009, Motorola, Inc.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * - Neither the name of the Motorola, Inc. nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.android.bluetooth.pbap;

import com.android.bluetooth.R;

import android.app.Service;
import android.content.Context;
import android.content.Intent;
import android.bluetooth.BluetoothAdapter;
import android.bluetooth.BluetoothDevice;
import android.bluetooth.BluetoothError;
import android.bluetooth.BluetoothIntent;
import android.bluetooth.BluetoothPbap;
import android.bluetooth.BluetoothSocket;
import android.bluetooth.BluetoothServerSocket;
import android.bluetooth.IBluetoothPbap;
import android.os.Handler;
import android.os.IBinder;
import android.os.Message;
import android.os.PowerManager;
import android.telephony.TelephonyManager;
import android.util.Log;
import android.widget.Toast;

import java.io.IOException;
import java.util.ArrayList;

import javax.obex.ServerSession;

public class BluetoothPbapService extends Service {

    private static final String TAG = "BluetoothPbapService";

    public static final boolean DBG = false;

    /**
     * Intent indicating incoming connection request which is sent to
     * BluetoothPbapActivity
     */
    public static final String ACCESS_REQUEST_ACTION = "com.android.bluetooth.pbap.accessrequest";

    /**
     * Intent indicating incoming connection request accepted by user which is
     * sent from BluetoothPbapActivity
     */
    public static final String ACCESS_ALLOWED_ACTION = "com.android.bluetooth.pbap.accessallowed";

    /**
     * Intent indicating incoming connection request denied by user which is
     * sent from BluetoothPbapActivity
     */
    public static final String ACCESS_DISALLOWED_ACTION =
        "com.android.bluetooth.pbap.accessdisallowed";

    /**
     * Intent indicating incoming obex authentication request which is from
     * PCE(Carkit)
     */
    public static final String AUTH_CHALL_ACTION = "com.android.bluetooth.pbap.authchall";

    /**
     * Intent indicating obex session key input complete by user which is sent
     * from BluetoothPbapActivity
     */
    public static final String AUTH_RESPONSE_ACTION = "com.android.bluetooth.pbap.authresponse";

    /**
     * Intent indicating user canceled obex authentication session key input
     * which is sent from BluetoothPbapActivity
     */
    public static final String AUTH_CANCELLED_ACTION = "com.android.bluetooth.pbap.authcancelled";

    /**
     * Intent indicating timeout for user confirmation, which is sent to
     * BluetoothPbapActivity
     */
    public static final String USER_CONFIRM_TIMEOUT_ACTION =
        "com.android.bluetooth.pbap.userconfirmtimeout";

    /**
     * Intent Extra name indicating always allowed which is sent from
     * BluetoothPbapActivity
     */
    public static final String EXTRA_ALWAYS_ALLOWED = "com.android.bluetooth.pbap.alwaysallowed";

    /**
     * Intent Extra name indicating session key which is sent from
     * BluetoothPbapActivity
     */
    public static final String EXTRA_SESSION_KEY = "com.android.bluetooth.pbap.sessionkey";

    public static final String THIS_PACKAGE_NAME = "com.android.bluetooth";

    public static final int MSG_SERVERSESSION_CLOSE = 5000;

    public static final int MSG_SESSION_ESTABLISHED = 5001;

    public static final int MSG_SESSION_DISCONNECTED = 5002;

    public static final int MSG_OBEX_AUTH_CHALL = 5003;

    private static final String BLUETOOTH_PERM = android.Manifest.permission.BLUETOOTH;

    private static final String BLUETOOTH_ADMIN_PERM = android.Manifest.permission.BLUETOOTH_ADMIN;

    private static final int START_LISTENER = 1;

    private static final int USER_TIMEOUT = 2;

    private static final int AUTH_TIMEOUT = 3;

    private PowerManager.WakeLock mWakeLock = null;

    private BluetoothAdapter mAdapter;

    private SocketAcceptThread mAcceptThread = null;

    private BluetoothPbapObexServer mPbapServer;

    private ServerSession mServerSession = null;

    private BluetoothServerSocket mServerSocket = null;

    private BluetoothSocket mConnSocket = null;

    private String mDeviceAddr = null;

    private static String sLocalPhoneNum = null;

    private static String sLocalPhoneName = null;

    private static String sRemoteDeviceName = null;

    private BluetoothDevice mRemoteDevice = null;

    private boolean mHasStarted = false;

    private int mState;

    private int mStartId = -1;

    private static final int PORT_NUM = 19;

    private static final int USER_CONFIRM_TIMEOUT_VALUE = 30000;

    private static final int SOCKET_ACCEPT_TIMEOUT_VALUE = 5000;

    private static final int TIME_TO_WAIT_VALUE = 6000;

    private static BluetoothPbapVcardManager sVcardManager;

    private CharSequence mTmpTxt;

    private BluetoothPbapAuthenticator mAuth = null;

    public BluetoothPbapService() {
        mState = BluetoothPbap.STATE_DISCONNECTED;
    }

    @Override
    public void onCreate() {
        super.onCreate();
        mAdapter = (BluetoothAdapter) getSystemService(Context.BLUETOOTH_SERVICE);
        if (mAdapter != null) {
            mDeviceAddr = mAdapter.getAddress();
        }
        sVcardManager = new BluetoothPbapVcardManager(BluetoothPbapService.this);
        if (!mHasStarted && mDeviceAddr != null) {
            mHasStarted = true;
            Log.i(TAG, "Starting PBAP service");
            int state = mAdapter.getBluetoothState();
            if (state == BluetoothAdapter.BLUETOOTH_STATE_ON) {
                mSessionStatusHandler.sendMessageDelayed(mSessionStatusHandler
                        .obtainMessage(START_LISTENER), TIME_TO_WAIT_VALUE);
            }
        }
    }

    @Override
    public void onStart(Intent intent, int startId) {
        mStartId = startId;
        if (mAdapter == null || mDeviceAddr == null) {
            Log.w(TAG, "Stopping BluetoothPbapService: "
                    + "device does not have BT or device is not ready");
            closeService(); // release all resources
        } else {
            parseIntent(intent);
        }
    }

    // process the intent from receiver
    private void parseIntent(final Intent intent) {
        String action = intent.getExtras().getString("action");
        int state = intent.getIntExtra(BluetoothIntent.BLUETOOTH_STATE, BluetoothError.ERROR);
        if (action.equals(BluetoothIntent.BLUETOOTH_STATE_CHANGED_ACTION)) {
            if (state == BluetoothAdapter.BLUETOOTH_STATE_OFF) {
                closeService(); // release all resources
            }
        } else if (action.equals(ACCESS_ALLOWED_ACTION)) {
            mSessionStatusHandler.removeMessages(USER_TIMEOUT);
            if (intent.getBooleanExtra(EXTRA_ALWAYS_ALLOWED, false)) {
                boolean result = mRemoteDevice.setTrust(true);
                if (DBG) {
                    Log.v(TAG, "setTrust() result=" + result);
                }
            }
            try {
                if (mConnSocket != null) {
                    startObexServerSession();
                } else {
                    obexServerSessionClose();
                }
            } catch (IOException ex) {
                if (DBG) {
                    Log.e(TAG, "Caught the error: " + ex.toString());
                }
            }
        } else if (action.equals(ACCESS_DISALLOWED_ACTION)) {
            mSessionStatusHandler.removeMessages(USER_TIMEOUT);
            obexServerSessionClose();
        } else if (action.equals(AUTH_RESPONSE_ACTION)) {
            mSessionStatusHandler.removeMessages(USER_TIMEOUT);
            String sessionkey = intent.getStringExtra(EXTRA_SESSION_KEY);
            notifyAuthKeyInput(sessionkey);
        } else if (action.equals(AUTH_CANCELLED_ACTION)) {
            mSessionStatusHandler.removeMessages(USER_TIMEOUT);
            notifyAuthCancelled();
        }
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        setState(BluetoothPbap.STATE_DISCONNECTED, BluetoothPbap.RESULT_CANCELED);
    }

    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }

    public static int getPhonebookSize(final int type) {
        if (DBG) {
            Log.d(TAG, "getPhonebookSzie type=" + type);
        }
        switch (type) {
            case BluetoothPbapObexServer.ContentType.PHONEBOOK:
                return sVcardManager.getPhonebookSize();
            default:
                return sVcardManager.getCallHistorySize(type);
        }
    }

    public static String getPhonebook(final int type, final int pos, final boolean vcardType) {
        if (DBG) {
            Log.d(TAG, "getPhonebook type=" + type + " pos=" + pos + " vcardType=" + vcardType);
        }
        switch (type) {
            case BluetoothPbapObexServer.ContentType.PHONEBOOK:
                return sVcardManager.getPhonebook(pos, vcardType);
            default:
                return sVcardManager.getCallHistory(pos, type, vcardType);
        }
    }

    public static String getLocalPhoneNum() {
        return sLocalPhoneNum;
    }

    public static String getLocalPhoneName() {
        return sLocalPhoneName;
    }

    public static String getRemoteDeviceName() {
        return sRemoteDeviceName;
    }

    // Used for phone book listing by name
    public static ArrayList<String> getPhonebookNameList() {
        return sVcardManager.loadNameList();
    }

    // Used for phone book listing by number
    public static ArrayList<String> getPhonebookNumberList() {
        return sVcardManager.loadNumberList();
    }

    // Used for call history listing
    public static ArrayList<String> getCallLogList(final int type) {
        return sVcardManager.loadCallHistoryList(type);
    }

    private void notifyAuthKeyInput(final String key) {
        synchronized (mAuth) {
            mAuth.setSessionKey(key);
            mAuth.setChallenged(true);
            mAuth.notify();
        }
    }

    private void notifyAuthCancelled() {
        synchronized (mAuth) {
            mAuth.setCancelled(true);
            mAuth.notify();
        }
    }

    private final boolean initSocket() {
        try {
            // It is mandatory for PSE to support initiation of bonding and
            // encryption.
            mServerSocket = mAdapter.listenUsingRfcommOn(PORT_NUM);
        } catch (IOException ex) {
            Log.e(TAG, "initSocket " + ex.toString());
            return false;
        }
        return true;
    }

    private final void startObexServerSession() throws IOException {
        // acquire the wakeLock before start Obex transaction thread
        if (mWakeLock == null) {
            PowerManager pm = (PowerManager)getSystemService(Context.POWER_SERVICE);
            mWakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK,
                    "StartingObexPbapTransaction");
            mWakeLock.setReferenceCounted(false);
            mWakeLock.acquire();
        }
        TelephonyManager tm = (TelephonyManager)getSystemService(Context.TELEPHONY_SERVICE);
        if (tm != null) {
            sLocalPhoneNum = tm.getLine1Number();
            sLocalPhoneName = tm.getLine1AlphaTag();
        }
        mPbapServer = new BluetoothPbapObexServer(mSessionStatusHandler);
        mAuth = new BluetoothPbapAuthenticator(mSessionStatusHandler);
        synchronized (mAuth) {
            mAuth.setChallenged(false);
            mAuth.setCancelled(false);
        }
        BluetoothPbapRfcommTransport transport = new BluetoothPbapRfcommTransport(mConnSocket);
        mServerSession = new ServerSession(transport, mPbapServer, mAuth);
        setState(BluetoothPbap.STATE_CONNECTED);
        if (DBG) {
            Log.v(TAG, "startObexServerSession() success!");
        }
    }

    private final void closeSocket(boolean server, boolean accept) throws IOException {
        if (server == true) {
            if (mServerSocket != null) {
                mServerSocket.close();
            }
            mServerSocket = null;
        }

        if (accept == true) {
            if (mConnSocket != null) {
                mConnSocket.close();
            }
            mConnSocket = null;
        }
    }

    private final void closeService() {
        if (mAcceptThread != null) {
            try {
                mAcceptThread.shutdown();
                mAcceptThread.join();
                mAcceptThread = null;
            } catch (InterruptedException ex) {
                Log.w(TAG, "mAcceptThread close error" + ex);
            }
        }
        if (mServerSession != null) {
            mServerSession.close();
            mServerSession = null;
        }
        try {
            closeSocket(true, true);
        } catch (IOException ex) {
            if (DBG) {
                Log.e(TAG, "Caught the error: " + ex);
            }
        }
        mHasStarted = false;
        BluetoothPbapReceiver.finishStartingService(BluetoothPbapService.this, mStartId);
    }

    private void obexServerSessionClose() {
        // Release the wake lock if obex transaction is over
        if (mWakeLock != null) {
            mWakeLock.release();
            mWakeLock = null;
        }
        mServerSession = null;
        mAcceptThread = null;
        try {
            closeSocket(false, true);
        } catch (IOException e) {
            if (DBG) {
                Log.e(TAG, "Caught the error: " + e.toString());
            }
        }
        // Last obex transaction is finished,we start to listen for incoming
        // connection again
        if (mAdapter.isEnabled()) {
            startRfcommSocketListener();
        }
        setState(BluetoothPbap.STATE_DISCONNECTED);
    }

    /**
     * A thread that runs in the background waiting for remote rfcomm
     * connect.Once a remote socket connected, this thread shall be
     * shutdown.When the remote disconnect,this thread shall run again waiting
     * for next request.
     */
    private class SocketAcceptThread extends Thread {

        private boolean stopped = false;

        @Override
        public void run() {
            while (!stopped) {
                try {
                    mConnSocket = mServerSocket.accept(SOCKET_ACCEPT_TIMEOUT_VALUE);
                } catch (IOException ex) {
                    if (stopped) {
                        break;
                    }
                    if (DBG) {
                        Log.v(TAG, "Caught the error in socketAcceptThread: " + ex);
                    }
                }
                if (mConnSocket != null) {
                    mRemoteDevice = mConnSocket.getRemoteDevice();
                    if (mRemoteDevice != null) {
                        sRemoteDeviceName = mRemoteDevice.getName();
                        // In case getRemoteName failed and return null
                        if (sRemoteDeviceName == null) {
                            sRemoteDeviceName = getString(R.string.defaultname);
                        }
                    }
                    boolean trust = mRemoteDevice.getTrustState();
                    if (DBG) {
                        Log.v(TAG, "GetTrustState() = " + trust);
                    }
                    if (trust) {
                        try {
                            if (DBG) {
                                Log.v(TAG, "Trusted device, incomming connection accepted auto.");
                            }
                            startObexServerSession();
                        } catch (IOException ex) {
                            Log.e(TAG, "catch exception starting obex server session"
                                    + ex.toString());
                        }
                    } else {
                        BluetoothPbapReceiver.makeNewPbapNotification(getApplicationContext(),
                                ACCESS_REQUEST_ACTION);
                        if (DBG) {
                            Log.v(TAG, "Incomming connection accepted from:" + sRemoteDeviceName);
                        }
                        // In case car kit time out and try to use HFP for phonebook
                        // access, while UI still there waiting for user to confirm
                        mSessionStatusHandler.sendMessageDelayed(mSessionStatusHandler
                                .obtainMessage(USER_TIMEOUT), USER_CONFIRM_TIMEOUT_VALUE);
                    }
                    stopped = true; // job done ,close this thread;
                }
            }
        }

        void shutdown() {
            stopped = true;
            interrupt();
        }
    }

    private void startRfcommSocketListener() {
        if (mServerSocket == null) {
            if (!initSocket()) {
                closeService();
                return;
            }
        }
        if (mAcceptThread == null) {
            mAcceptThread = new SocketAcceptThread();
            mAcceptThread.setName("BluetoothPbapAcceptThread");
            mAcceptThread.start();
        }
    }

    private void setState(int state) {
        setState(state, BluetoothPbap.RESULT_SUCCESS);
    }

    private synchronized void setState(int state, int result) {
        if (state != mState) {
            if (DBG)
                Log.d(TAG, "Pbap state " + mState + " -> " + state + ", result = " + result);
            Intent intent = new Intent(BluetoothPbap.PBAP_STATE_CHANGED_ACTION);
            intent.putExtra(BluetoothPbap.PBAP_PREVIOUS_STATE, mState);
            mState = state;
            intent.putExtra(BluetoothPbap.PBAP_STATE, mState);
            intent.putExtra(BluetoothIntent.DEVICE, mRemoteDevice);
            sendBroadcast(intent, BLUETOOTH_PERM);
        }
    }

    /**
     * Handlers for incoming service calls
     */
    private final IBluetoothPbap.Stub mBinder = new IBluetoothPbap.Stub() {
        public int getState() {
            if (DBG) {
                Log.d(TAG, "getState " + mState);
            }
            enforceCallingOrSelfPermission(BLUETOOTH_PERM, "Need BLUETOOTH permission");
            return mState;
        }

        public BluetoothDevice getClient() {
            if (DBG) {
                Log.d(TAG, "getClient" + mRemoteDevice);
            }
            enforceCallingOrSelfPermission(BLUETOOTH_PERM, "Need BLUETOOTH permission");
            if (mState == BluetoothPbap.STATE_DISCONNECTED) {
                return null;
            }
            return mRemoteDevice;
        }

        public boolean isConnected(BluetoothDevice device) {
            enforceCallingOrSelfPermission(BLUETOOTH_PERM, "Need BLUETOOTH permission");
            return mState == BluetoothPbap.STATE_CONNECTED && mRemoteDevice.equals(device);
        }

        public boolean connect(BluetoothDevice device) {
            enforceCallingOrSelfPermission(BLUETOOTH_ADMIN_PERM,
                    "Need BLUETOOTH_ADMIN permission");
            return false;
        }

        public void disconnect() {
            if (DBG) {
                Log.d(TAG, "disconnect");
            }
            enforceCallingOrSelfPermission(BLUETOOTH_ADMIN_PERM,
                    "Need BLUETOOTH_ADMIN permission");
            synchronized (BluetoothPbapService.this) {
                switch (mState) {
                    case BluetoothPbap.STATE_CONNECTED:
                        if (mServerSession != null) {
                            mServerSession.close();
                            mServerSession = null;
                        }
                        try {
                            closeSocket(false, true);
                        } catch (IOException ex) {
                            Log.e(TAG, "Caught the error: " + ex);
                        }
                        setState(BluetoothPbap.STATE_DISCONNECTED, BluetoothPbap.RESULT_CANCELED);
                        break;
                }
            }
        }
    };

    private final Handler mSessionStatusHandler = new Handler() {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case START_LISTENER:
                    if (mAdapter.isEnabled()) {
                        startRfcommSocketListener();
                    } else {
                        closeService();// release all resources
                    }
                    break;
                case USER_TIMEOUT:
                    Intent intent = new Intent(USER_CONFIRM_TIMEOUT_ACTION);
                    sendBroadcast(intent);
                    BluetoothPbapReceiver.removePbapNotification(getApplicationContext(),
                            BluetoothPbapReceiver.NOTIFICATION_ID_ACCESS);
                    obexServerSessionClose();
                    break;
                case AUTH_TIMEOUT:
                    Intent i = new Intent(USER_CONFIRM_TIMEOUT_ACTION);
                    sendBroadcast(i);
                    BluetoothPbapReceiver.removePbapNotification(getApplicationContext(),
                            BluetoothPbapReceiver.NOTIFICATION_ID_AUTH);
                    notifyAuthCancelled();
                    break;
                case MSG_SERVERSESSION_CLOSE:
                    obexServerSessionClose();
                    mTmpTxt = getString(R.string.toast_disconnected, sRemoteDeviceName);
                    Toast.makeText(BluetoothPbapService.this, mTmpTxt, Toast.LENGTH_SHORT).show();
                    break;
                case MSG_SESSION_ESTABLISHED:
                    mTmpTxt = getString(R.string.toast_connected, sRemoteDeviceName);
                    Toast.makeText(BluetoothPbapService.this, mTmpTxt, Toast.LENGTH_SHORT).show();
                    break;
                case MSG_SESSION_DISCONNECTED:
                    // case MSG_SERVERSESSION_CLOSE will handle ,so just skip
                    break;
                case MSG_OBEX_AUTH_CHALL:
                    BluetoothPbapReceiver.makeNewPbapNotification(getApplicationContext(),
                            AUTH_CHALL_ACTION);
                    mSessionStatusHandler.sendMessageDelayed(mSessionStatusHandler
                            .obtainMessage(AUTH_TIMEOUT), USER_CONFIRM_TIMEOUT_VALUE);
                    break;
            }
        }
    };
}