DeviceStatusPlugin.java

/**
 * Copyright (c) 2011, SOCIETIES Consortium (WATERFORD INSTITUTE OF TECHNOLOGY (TSSG), HERIOT-WATT UNIVERSITY (HWU), SOLUTA.NET 
 * (SN), GERMAN AEROSPACE CENTRE (Deutsches Zentrum fuer Luft- und Raumfahrt e.V.) (DLR), Zavod za varnostne tehnologije
 * informacijske družbe in elektronsko poslovanje (SETCCE), INSTITUTE OF COMMUNICATION AND COMPUTER SYSTEMS (ICCS), LAKE
 * COMMUNICATIONS (LAKE), INTEL PERFORMANCE LEARNING SOLUTIONS LTD (INTEL), PORTUGAL TELECOM INOVAÇÃO, SA (PTIN), IBM Corp., 
 * INSTITUT TELECOM (ITSUD), AMITEC DIACHYTI EFYIA PLIROFORIKI KAI EPIKINONIES ETERIA PERIORISMENIS EFTHINIS (AMITEC), TELECOM 
 * ITALIA S.p.a.(TI),  TRIALOG (TRIALOG), Stiftelsen SINTEF (SINTEF), NEC EUROPE LTD (NEC))
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 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 org.societies.android.platform.phongegap;

import java.util.ArrayList;
import java.util.List;

import org.apache.cordova.api.Plugin;
import org.apache.cordova.api.PluginResult;
import org.apache.cordova.api.PluginResult.Status;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.societies.android.api.utilities.ServiceMethodTranslator;
import org.societies.android.api.internal.devicemonitor.BatteryStatus;
import org.societies.android.api.internal.devicemonitor.IDeviceStatus;
import org.societies.android.api.internal.devicemonitor.ProviderStatus;
import org.societies.android.platform.devicestatus.LocalDeviceStatusService;

import android.content.BroadcastReceiver;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.ServiceConnection;
import android.os.BatteryManager;
import android.os.Bundle;
import android.os.IBinder;
import android.os.Message;
import android.os.Messenger;
import android.os.RemoteException;
import android.util.Log;

import com.google.gson.Gson;

/**
 * PhoneGap plugin to use device status
 * To show the Javascript API: use "mvn site" on this project, and go to target/doc folder
 * @author Olivier Maridat (Trialog)
 */
public class DeviceStatusPlugin extends Plugin {
	/** Actions List */
	public static final String ACTION_CONNECTIVITY = "getConnectivityStatus";
	public static final String ACTION_LOCATION = "getLocationStatus";
	public static final String ACTION_BATTERY = "getBatteryStatus";
	public static final String ACTION_BATTERY_REGISTER = "registerBatteryStatus";

	/** Callback to call */
	public String methodName;
	public JSONArray arguments;
	public String callbackID;

	/** Helpers */
	protected Gson jsonHelper;

	/** Local data */
	private boolean batteryStatusRegistration = false;
	/* Device Status Service */
	private boolean deviceStatusServiceConnected = false;
	private Messenger deviceStatusService = null;
	private ServiceReceiver deviceStatusReceiver = null;


	/**
	 * This method is called when the plugin is created
	 * before the excecution of "excecute"
	 * Perfect to initialize an Android Service
	 */
	@Override
	public void onResume(boolean arg) {
//		Log.d("DeviceStatusPlugin", "DeviceStatusPlugin resumed");
//		// Link to the Android service
//		if (!deviceStatusServiceConnected) {
//			Intent deviceStatusIntent = new Intent(this.ctx, DeviceStatusServiceDifferentProcess.class);
//			this.ctx.bindService(deviceStatusIntent, deviceStatusServiceConnection, Context.BIND_AUTO_CREATE);
//		}
//		// Create the broadcast receiver
//		if (null == deviceStatusReceiver) {
//			deviceStatusReceiver = new ServiceReceiver();
//		}
	}

	/*
	 * @see com.phonegap.api.Plugin#execute(java.lang.String, org.json.JSONArray, java.lang.String)
	 */
	@Override
	public PluginResult execute(String methodName, JSONArray arguments, String callbackID)
	{
		// If needed : connect to the DeviceStatus Android service
		// /!\ This is dirty, but "onResume" method seems to be bugged. We will clean that later.
		if (!deviceStatusServiceConnected && null != methodName && (ACTION_CONNECTIVITY.equals(methodName) || ACTION_LOCATION.equals(methodName))) {
			Log.d(this.getClass().getSimpleName(), "Plugin Called (first time: connect to service)");
			Intent deviceStatusIntent = new Intent(this.ctx.getContext(), LocalDeviceStatusService.class);
			// - Inform the JS side: async mode
			PluginResult result = new PluginResult(Status.NO_RESULT);
			result.setKeepCallback(true);
			this.methodName = methodName;
			this.arguments = arguments;
			this.callbackID = callbackID;
			this.ctx.getContext().bindService(deviceStatusIntent, deviceStatusServiceConnection, Context.BIND_AUTO_CREATE);
			return result;
		}
		else {
			return executePlugin(methodName, arguments, callbackID);
		}
	}

	public PluginResult executePlugin(String methodName, JSONArray arguments, String callbackID)
	{
		Log.d(this.getClass().getSimpleName(), "Plugin Called");


		// Create the broadcast receiver
		if (null == deviceStatusReceiver) {
			deviceStatusReceiver = new ServiceReceiver();
		}

		// --- Save the callback
		this.callbackID = callbackID;

		// --- Prepare the result
		PluginResult result = null;
		jsonHelper = new Gson();

		try {
			// -- Manage the relevant method
			// - Connectivity Provider Status
			if (ACTION_CONNECTIVITY.equals(methodName)) {
				Log.d(this.getClass().getSimpleName(), "Connectivity Status");
				// - Inform the JS side: async mode
				result = new PluginResult(Status.NO_RESULT);
				result.setKeepCallback(true);
				this.success(result, callbackID);

				// - Launch location status retrieval
				// Register to the relevant broadcast receiver
				IntentFilter filter = new IntentFilter(IDeviceStatus.CONNECTIVITY_STATUS);
				this.ctx.getContext().registerReceiver(deviceStatusReceiver, filter);

				// Launch the relevant method
				// Fill the method name
				String nameGetConnectivityProvidersStatus = "getConnectivityProvidersStatus(String callerPackageName)";
				Message getConnectivityProvidersStatus = Message.obtain(null, ServiceMethodTranslator.getMethodIndex(IDeviceStatus.methodsArray, nameGetConnectivityProvidersStatus), 0, 0);
				// Fill the parameters
				Bundle getConnectivityProvidersStatusParams = new Bundle();
				getConnectivityProvidersStatusParams.putString(ServiceMethodTranslator.getMethodParameterName(nameGetConnectivityProvidersStatus, 0), this.getClass().getPackage().getName());
				getConnectivityProvidersStatus.setData(getConnectivityProvidersStatusParams);
				// Launch
				if (deviceStatusServiceConnected) {
					deviceStatusService.send(getConnectivityProvidersStatus);
				}
				else {
					Log.d(this.getClass().getSimpleName(), "DeviceStatus service not connected.");
				}
			}
			// - Location Provider Status
			else if (ACTION_LOCATION.equals(methodName)) {
				Log.d(this.getClass().getSimpleName(), "Location Status");
				// - Inform the JS side: async mode
				result = new PluginResult(Status.NO_RESULT);
				result.setKeepCallback(true);
				this.success(result, callbackID);

				// - Launch location status retrieval
				// Register to the relevant broadcast receiver
				IntentFilter filter = new IntentFilter(IDeviceStatus.LOCATION_STATUS);
				this.ctx.getContext().registerReceiver(deviceStatusReceiver, filter);

				// Launch the relevant method
				// Fill the method name
				String nameGetLocationProvidersStatus = "getLocationProvidersStatus(String callerPackageName)";
				Message getLocationProvidersStatus = Message.obtain(null, ServiceMethodTranslator.getMethodIndex(IDeviceStatus.methodsArray, nameGetLocationProvidersStatus), 0, 0);
				// Fill the parameters
				Bundle getLocationProvidersStatusParams = new Bundle();
				getLocationProvidersStatusParams.putString(ServiceMethodTranslator.getMethodParameterName(nameGetLocationProvidersStatus, 0), this.getClass().getPackage().getName());
				getLocationProvidersStatus.setData(getLocationProvidersStatusParams);
				// Launch
				if (deviceStatusServiceConnected) {
					deviceStatusService.send(getLocationProvidersStatus);
				}
				else {
					Log.d(this.getClass().getSimpleName(), "DeviceStatus service not connected.");
				}
			}
			// - Battery Status
			else if (ACTION_BATTERY.equals(methodName)) {
				Log.d(this.getClass().getSimpleName(), "Battery Status");
				// Inform the JS side: async mode
				result = new PluginResult(Status.NO_RESULT);
				result.setKeepCallback(true);
				this.success(result, callbackID);
				// -- Launch the intent to retrieve the battery status
				IntentFilter batteryLevelFilter = new IntentFilter(Intent.ACTION_BATTERY_CHANGED);
				this.ctx.getContext().registerReceiver(deviceStatusReceiver, batteryLevelFilter);
			}
			// - Register to battery status
			else if (ACTION_BATTERY_REGISTER.equals(methodName)) {
				Log.d(this.getClass().getSimpleName(), "Register battery Status");
				// Inform the JS side: async mode
				result = new PluginResult(Status.NO_RESULT);
				result.setKeepCallback(true);
				this.success(result, callbackID);
				// -- Launch the intent to retrieve the battery status
				// Register or poll?
				JSONObject params = (JSONObject) arguments.get(0);
				batteryStatusRegistration = params.getBoolean("register");
				IntentFilter filter = new IntentFilter(Intent.ACTION_BATTERY_CHANGED);
				this.ctx.getContext().registerReceiver(deviceStatusReceiver, filter);
			}

			// -- Error: Unknown method name
			else {
				Log.d(this.getClass().getSimpleName(), "Invalid method name : "+methodName+" passed");
				result = new PluginResult(Status.INVALID_ACTION);
			}
		}
		catch (JSONException e) {
			result = new PluginResult(Status.ERROR, "Error during the JSON parsing");
			result.setKeepCallback(false);
			this.error(result, this.callbackID);
		}
		catch (RemoteException e) {
			result = new PluginResult(Status.ERROR, "No such method in this service");
			result.setKeepCallback(false);
			this.error(result, this.callbackID);
		}
		return result;
	}

	@Override
	public void onDestroy()
	{
		Log.d(this.getClass().getSimpleName(), "DeviceStatusPlugin Destroy");
		// -- Close the broadcast receiver
		if (null != deviceStatusReceiver) {
			this.ctx.getContext().unregisterReceiver(deviceStatusReceiver);
		}
		// -- Unlink with services
		if (deviceStatusServiceConnected) {
			deviceStatusServiceConnected = false;
			this.ctx.getContext().unbindService(deviceStatusServiceConnection);
		}
	}


	//--------------------------------------------------------------------------
	// LOCAL METHODS
	//--------------------------------------------------------------------------

	public PluginResult getConnectivityStatus(Intent intent) throws JSONException
	{
		JSONObject data = new JSONObject();
		// --- Internet
		boolean isInternetEnabled = false;
		if(intent.hasExtra(IDeviceStatus.CONNECTIVITY_INTERNET_ON)) {
			isInternetEnabled = intent.getBooleanExtra(IDeviceStatus.CONNECTIVITY_INTERNET_ON, false);
		}
		data.put("isInternetEnabled", isInternetEnabled);

		// --- Providers
		List<ProviderStatus> connectivityProviders = new ArrayList<ProviderStatus>();
		if(intent.hasExtra(IDeviceStatus.CONNECTIVITY_PROVIDER_LIST)) {
			connectivityProviders = intent.getParcelableArrayListExtra(IDeviceStatus.CONNECTIVITY_PROVIDER_LIST);
		}
		JSONArray connectivityProviderList = new JSONArray();
		for(ProviderStatus provider : connectivityProviders) {
			JSONObject connectivityProvider = new JSONObject();
			connectivityProvider.put("name", provider.getName());
			connectivityProvider.put("enabled", provider.isEnabled());
			connectivityProviderList.put(connectivityProvider);
		}
		data.put("providerList", connectivityProviderList);
		Log.d(this.getClass().getSimpleName(), data.toString());

		// -- Send data
		PluginResult result = new PluginResult(Status.OK, data);
		result.setKeepCallback(false);
		this.success(result, this.callbackID);
		return result;
	}

	public PluginResult getLocationStatus(Intent intent) throws JSONException
	{
		JSONObject data = new JSONObject();
		// --- Providers
		List<ProviderStatus> locationProviders = new ArrayList<ProviderStatus>();
		if(intent.hasExtra(IDeviceStatus.LOCATION_PROVIDER_LIST)) {
			locationProviders = intent.getParcelableArrayListExtra(IDeviceStatus.LOCATION_PROVIDER_LIST);
		}
		JSONArray connectivityProviderList = new JSONArray();
		for(ProviderStatus provider : locationProviders) {
			JSONObject locationProvider = new JSONObject();
			locationProvider.put("name", provider.getName());
			locationProvider.put("enabled", provider.isEnabled());
			connectivityProviderList.put(locationProvider);
		}
		data.put("providerList", connectivityProviderList);
		Log.d(this.getClass().getSimpleName(), data.toString());

		// -- Send data
		PluginResult result = new PluginResult(Status.OK, data);
		result.setKeepCallback(false);
		this.success(result, this.callbackID);
		return result;
	}

	public PluginResult getBatteryStatus(Intent intent) throws JSONException
	{
		// -- Battery
		double level = -1;
		double temperature = -1;
		double voltage = -1;
		int rawLevel = intent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1);
		int scale = intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1);
		int rawTemperature = intent.getIntExtra(BatteryManager.EXTRA_TEMPERATURE, -1);
		int rawVoltage = intent.getIntExtra(BatteryManager.EXTRA_VOLTAGE, -1);
		int status = intent.getIntExtra(BatteryManager.EXTRA_STATUS, -1);
		int plugged = intent.getIntExtra(BatteryManager.EXTRA_PLUGGED, -1);
		if (rawLevel >= 0 && scale > 0) {
			level = (rawLevel * 100) / scale;
		}
		if (rawTemperature >= 0) {
			temperature = rawTemperature/10;
		}
		if (rawVoltage >= 0) {
			voltage = rawVoltage/1000;
		}
		BatteryStatus batteryStatus = new BatteryStatus(level, scale, voltage, temperature, status, plugged);
		Log.d(this.getClass().getSimpleName(), batteryStatus.toString());

		// -- Send data
		JSONObject data = new JSONObject(jsonHelper.toJson(batteryStatus, BatteryStatus.class)); // It is better to send a JSON Object than a String
		PluginResult result = new PluginResult(Status.OK, data);
		result.setKeepCallback(false);
		this.success(result, this.callbackID);
		return result;
	}

	/**
	 * Broadcast receiver to receive intents from Service methods
	 * 
	 * TODO: Intent Categories could be used to discriminate between 
	 * returned method intents rather than an intent per method 
	 *
	 */
	private class ServiceReceiver extends BroadcastReceiver {
		@Override
		public void onReceive(Context context, Intent intent) {
			Log.i(this.getClass().getSimpleName(), intent.getAction());
			try {
				// -- Connectivity
				if (intent.getAction().equals(IDeviceStatus.CONNECTIVITY_STATUS)) {
					getConnectivityStatus(intent);
				}
				// -- Location
				else if (intent.getAction().equals(IDeviceStatus.LOCATION_STATUS)) {
					getLocationStatus(intent);
				}
				// -- Battery
				else if (intent.getAction().equals(Intent.ACTION_BATTERY_CHANGED)) {
					if (!batteryStatusRegistration) {
						context.unregisterReceiver(this);
					}
					getBatteryStatus(intent);
				}
			}
			catch (JSONException e) {
				PluginResult result = new PluginResult(Status.ERROR, "Error during the JSON parsing of the result");
				result.setKeepCallback(false);
				error(result, callbackID);
			}
		}
	}

	private ServiceConnection deviceStatusServiceConnection = new ServiceConnection()
	{
		public void onServiceDisconnected(ComponentName name)
		{
			deviceStatusServiceConnected = false;
		}
		public void onServiceConnected(ComponentName name, IBinder service)
		{
			deviceStatusService = new Messenger(service);
			deviceStatusServiceConnected = true;
			executePlugin(methodName, arguments, callbackID);
		}
	};
}