Initial change on carrier signal filtering (b5771d36) · Commits · e / os / android_frameworks_opt_telephony

src/java/com/android/internal/telephony/CarrierActionAgent.java

0 → 100644

+199 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2016 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.internal.telephony;

		import android.os.AsyncResult;
		import android.os.Handler;
		import android.os.Message;
		import android.os.Registrant;
		import android.os.RegistrantList;
		import android.telephony.Rlog;
		import android.util.LocalLog;
		import android.util.Log;

		import com.android.internal.util.IndentingPrintWriter;

		import java.io.FileDescriptor;
		import java.io.PrintWriter;

		/**
		* Carrier Action Agent(CAA) paired with
		* {@link com.android.internal.telephony.CarrierSignalAgent CarrierSignalAgent},
		* serves as an agent to dispatch carrier actions from carrier apps to different telephony modules,
		* {@link android.telephony.TelephonyManager#carrierActionSetRadioEnabled(int, boolean)
		* carrierActionSetRadioEnabled} for example.
		*
		* CAA supports dynamic registration where different telephony modules could listen for a specific
		* carrier action event and implement their own handler. CCA will dispatch the event to all
		* interested parties and maintain the received action states internally for future inspection.
		* Each CarrierActionAgent is associated with a phone object.
		*/
		public class CarrierActionAgent extends Handler {
		private static final String LOG_TAG = "CarrierActionAgent";
		private static final boolean DBG = true;
		private static final boolean VDBG = Rlog.isLoggable(LOG_TAG, Log.VERBOSE);

		/** A list of carrier actions */
		public static final int CARRIER_ACTION_SET_METERED_APNS_ENABLED = 0;
		public static final int CARRIER_ACTION_SET_RADIO_ENABLED = 1;

		/** Member variables */
		private final Phone mPhone;
		/** registrant list per carrier action */
		private RegistrantList mMeteredApnEnableRegistrants = new RegistrantList();
		private RegistrantList mRadioEnableRegistrants = new RegistrantList();
		/** local log for carrier actions */
		private LocalLog mMeteredApnEnabledLog = new LocalLog(10);
		private LocalLog mRadioEnabledLog = new LocalLog(10);
		/** carrier actions, true by default */
		private Boolean mCarrierActionOnMeteredApnEnabled = true;
		private Boolean mCarrierActionOnRadioEnabled = true;

		/** Constructor */
		public CarrierActionAgent(Phone phone) {
		mPhone = phone;
		if (DBG) log("Creating CarrierActionAgent");
		}

		@Override
		public void handleMessage(Message msg) {
		switch (msg.what) {
		case CARRIER_ACTION_SET_METERED_APNS_ENABLED:
		mCarrierActionOnMeteredApnEnabled = (boolean) msg.obj;
		log("SET_METERED_APNS_ENABLED: " + mCarrierActionOnMeteredApnEnabled);
		mMeteredApnEnabledLog.log("SET_METERED_APNS_ENABLED: "
		+ mCarrierActionOnMeteredApnEnabled);
		mMeteredApnEnableRegistrants.notifyRegistrants(
		new AsyncResult(null, mCarrierActionOnMeteredApnEnabled, null));
		break;
		case CARRIER_ACTION_SET_RADIO_ENABLED:
		mCarrierActionOnRadioEnabled = (boolean) msg.obj;
		log("SET_RADIO_ENABLED: " + mCarrierActionOnRadioEnabled);
		mRadioEnabledLog.log("SET_RADIO_ENABLED: " + mCarrierActionOnRadioEnabled);
		mRadioEnableRegistrants.notifyRegistrants(
		new AsyncResult(null, mCarrierActionOnRadioEnabled, null));
		break;
		default:
		loge("Unknown carrier action: " + msg.what);
		}
		}

		/**
		* Return current carrier action values
		*/
		public Object getCarrierActionValue(int action) {
		Object val = getCarrierAction(action);
		if (val == null) {
		throw new IllegalArgumentException("invalid carrier action: " + action);
		}
		return val;
		}

		/**
		* Action set from carrier app to enable/disable radio
		*/
		public void carrierActionSetRadioEnabled(boolean enabled) {
		sendMessage(obtainMessage(CARRIER_ACTION_SET_RADIO_ENABLED, enabled));
		}

		/**
		* Action set from carrier app to enable/disable metered APNs
		*/
		public void carrierActionSetMeteredApnsEnabled(boolean enabled) {
		sendMessage(obtainMessage(CARRIER_ACTION_SET_METERED_APNS_ENABLED, enabled));
		}

		private RegistrantList getRegistrantsFromAction(int action) {
		switch (action) {
		case CARRIER_ACTION_SET_METERED_APNS_ENABLED:
		return mMeteredApnEnableRegistrants;
		case CARRIER_ACTION_SET_RADIO_ENABLED:
		return mRadioEnableRegistrants;
		default:
		loge("Unsupported action: " + action);
		return null;
		}
		}

		private Object getCarrierAction(int action) {
		switch (action) {
		case CARRIER_ACTION_SET_METERED_APNS_ENABLED:
		return mCarrierActionOnMeteredApnEnabled;
		case CARRIER_ACTION_SET_RADIO_ENABLED:
		return mCarrierActionOnRadioEnabled;
		default:
		loge("Unsupported action: " + action);
		return null;
		}
		}

		/**
		* Register with CAA for a specific event.
		* @param action which carrier action registrant is interested in
		* @param notifyNow if carrier action has once set, notify registrant right after
		* registering, so that registrants will get the latest carrier action.
		*/
		public void registerForCarrierAction(int action, Handler h, int what, Object obj,
		boolean notifyNow) {
		Object carrierAction = getCarrierAction(action);
		if (carrierAction == null) {
		throw new IllegalArgumentException("invalid carrier action: " + action);
		}
		RegistrantList list = getRegistrantsFromAction(action);
		Registrant r = new Registrant(h, what, obj);
		list.add(r);
		if (notifyNow) {
		r.notifyRegistrant(new AsyncResult(null, carrierAction, null));
		}
		}

		/**
		* Unregister with CAA for a specific event. Callers will no longer be notified upon such event.
		* @param action which carrier action caller is no longer interested in
		*/
		public void unregisterForCarrierAction(Handler h, int action) {
		RegistrantList list = getRegistrantsFromAction(action);
		if (list == null) {
		throw new IllegalArgumentException("invalid carrier action: " + action);
		}
		list.remove(h);
		}

		private void log(String s) {
		Rlog.d(LOG_TAG, "[" + mPhone.getPhoneId() + "]" + s);
		}

		private void loge(String s) {
		Rlog.e(LOG_TAG, "[" + mPhone.getPhoneId() + "]" + s);
		}

		private void logv(String s) {
		Rlog.v(LOG_TAG, "[" + mPhone.getPhoneId() + "]" + s);
		}

		public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
		IndentingPrintWriter ipw = new IndentingPrintWriter(pw, " ");
		pw.println(" mCarrierActionOnMeteredApnsEnabled Log:");
		ipw.increaseIndent();
		mMeteredApnEnabledLog.dump(fd, ipw, args);
		ipw.decreaseIndent();

		pw.println(" mCarrierActionOnRadioEnabled Log:");
		ipw.increaseIndent();
		mRadioEnabledLog.dump(fd, ipw, args);
		ipw.decreaseIndent();
		}
		}

src/java/com/android/internal/telephony/CarrierSignalAgent.java

+217 −78

Original line number	Diff line number	Diff line
		@@ -16,69 +16,107 @@
		package com.android.internal.telephony;

		import android.content.ActivityNotFoundException;
		import android.content.BroadcastReceiver;
		import android.content.ComponentName;
		import android.content.Context;
		import android.content.Intent;
		import android.content.IntentFilter;
		import android.content.pm.PackageManager;
		import android.os.PersistableBundle;
		import android.telephony.CarrierConfigManager;
		import android.telephony.Rlog;
		import android.text.TextUtils;
		import android.util.LocalLog;
		import android.util.Log;

		import com.android.internal.util.ArrayUtils;
		import com.android.internal.util.IndentingPrintWriter;

		import java.io.FileDescriptor;
		import java.io.PrintWriter;
		import java.util.ArrayList;
		import java.util.Arrays;
		import java.util.HashMap;
		import java.util.HashSet;
		import java.util.List;
		import java.util.Map;
		import java.util.Set;

		import static android.telephony.CarrierConfigManager.KEY_CARRIER_APP_WAKE_SIGNAL_CONFIG_STRING_ARRAY;
		import static android.telephony.CarrierConfigManager.KEY_CARRIER_APP_NO_WAKE_SIGNAL_CONFIG_STRING_ARRAY;

		/**
		* This class act as an CarrierSignalling Agent.
		* it load registered carrier signalling receivers from Carrier Config and cache the result to avoid
		* it load registered carrier signalling receivers from carrier config, cache the result to avoid
		* repeated polling and send the intent to the interested receivers.
		* each CarrierSignalAgent is associated with a phone object.
		* Each CarrierSignalAgent is associated with a phone object.
		*/
		public class CarrierSignalAgent {

		private static final String LOG_TAG = "CarrierSignalAgent";
		private static final String LOG_TAG = CarrierSignalAgent.class.getSimpleName();
		private static final boolean DBG = true;
		private static final boolean VDBG = Rlog.isLoggable(LOG_TAG, Log.VERBOSE);
		private static final boolean WAKE = true;
		private static final boolean NO_WAKE = false;

		/** delimiters for parsing config of the form: pakName./receiverName : signal1, signal2,..*/
		private static final String COMPONENT_NAME_DELIMITER = "\\s:\\s";
		private static final String CARRIER_SIGNAL_DELIMITER = "\\s,\\s";

		/** Member variables */
		private final Phone mPhone;

		/**
		* This is a map of intent action -> array list of component name of statically registered
		* carrier signal receivers(wakeup receivers).
		* Those intents are declared in the Manifest files, aiming to wakeup broadcast receivers.
		* Carrier apps should be careful when configuring the wake signal list to avoid unnecessary
		* wakeup.
		* @see CarrierConfigManager#KEY_CARRIER_APP_WAKE_SIGNAL_CONFIG_STRING_ARRAY
		*/
		private final Map<String, List<ComponentName>> mCachedWakeSignalConfigs = new HashMap<>();

		/**
		* This is a map of intent action -> string array of carrier signal receiver names which are
		* interested in this intent action
		* This is a map of intent action -> array list of component name of dynamically registered
		* carrier signal receivers(non-wakeup receivers). Those intents will not wake up the apps.
		* Note Carrier apps should avoid configuring no wake signals in there Manifest files.
		* @see CarrierConfigManager#KEY_CARRIER_APP_NO_WAKE_SIGNAL_CONFIG_STRING_ARRAY
		*/
		private final HashMap<String, String[]> mCachedCarrierSignalReceiverNames =
		new HashMap<>();
		private final Map<String, List<ComponentName>> mCachedNoWakeSignalConfigs = new HashMap<>();

		/**
		* This is a map of intent action -> carrier config key of signal receiver names which are
		* interested in this intent action
		* This is a list of supported signals from CarrierSignalAgent
		*/
		private final Map<String, String> mIntentToCarrierConfigKeyMap =
		new HashMap<String, String>() {{
		put(TelephonyIntents.ACTION_CARRIER_SIGNAL_REDIRECTED,
		CarrierConfigManager.KEY_SIGNAL_REDIRECTION_RECEIVER_STRING_ARRAY);
		put(TelephonyIntents.ACTION_CARRIER_SIGNAL_PCO_VALUE,
		CarrierConfigManager.KEY_SIGNAL_PCO_RECEIVER_STRING_ARRAY);
		put(TelephonyIntents.ACTION_CARRIER_SIGNAL_REQUEST_NETWORK_FAILED,
		CarrierConfigManager.KEY_SIGNAL_DCFAILURE_RECEIVER_STRING_ARRAY);
		}};
		private final Set<String> mCarrierSignalList = new HashSet<>(Arrays.asList(
		TelephonyIntents.ACTION_CARRIER_SIGNAL_PCO_VALUE.toLowerCase(),
		TelephonyIntents.ACTION_CARRIER_SIGNAL_REDIRECTED.toLowerCase(),
		TelephonyIntents.ACTION_CARRIER_SIGNAL_REQUEST_NETWORK_FAILED.toLowerCase()));

		private final LocalLog mErrorLocalLog = new LocalLog(20);

		private final BroadcastReceiver mReceiver = new BroadcastReceiver() {
		public void onReceive(Context context, Intent intent) {
		String action = intent.getAction();
		if (DBG) log("CarrierSignalAgent receiver action: " + action);
		if (action.equals(CarrierConfigManager.ACTION_CARRIER_CONFIG_CHANGED)) {
		loadCarrierConfig();
		}
		}
		};

		/** Constructor */
		public CarrierSignalAgent(Phone phone) {
		mPhone = phone;
		loadCarrierConfig();
		// reload configurations on CARRIER_CONFIG_CHANGED
		mPhone.getContext().registerReceiver(mReceiver,
		new IntentFilter(CarrierConfigManager.ACTION_CARRIER_CONFIG_CHANGED));
		}

		/**
		* Read carrier signalling receiver name from CarrierConfig based on the intent type
		* @return array of receiver Name: the package (a String) name / the class (a String) name
		* load carrier config and cached the results into a hashMap action -> array list of components.
		*/
		private String[] getCarrierSignalReceiverName(String intentAction) {
		String receiverType = mIntentToCarrierConfigKeyMap.get(intentAction);
		if(receiverType == null) {
		return null;
		}
		String[] receiverNames = mCachedCarrierSignalReceiverNames.get(intentAction);
		// In case of cache miss, we need to look up/load from carrier config.
		if (!mCachedCarrierSignalReceiverNames.containsKey(intentAction)) {
		private void loadCarrierConfig() {
		CarrierConfigManager configManager = (CarrierConfigManager) mPhone.getContext()
		.getSystemService(Context.CARRIER_CONFIG_SERVICE);
		PersistableBundle b = null;
		@@ -86,74 +124,148 @@ public class CarrierSignalAgent {
		b = configManager.getConfig();
		}
		if (b != null) {
		receiverNames = b.getStringArray(receiverType);
		if(receiverNames!=null) {
		for(String name: receiverNames) {
		Rlog.d("loadCarrierSignalReceiverNames: ", name);
		}
		synchronized (mCachedWakeSignalConfigs) {
		mCachedWakeSignalConfigs.clear();
		log("Loading carrier config: " + KEY_CARRIER_APP_WAKE_SIGNAL_CONFIG_STRING_ARRAY);
		parseAndCache(b.getStringArray(KEY_CARRIER_APP_WAKE_SIGNAL_CONFIG_STRING_ARRAY),
		mCachedWakeSignalConfigs);
		}

		synchronized (mCachedNoWakeSignalConfigs) {
		mCachedNoWakeSignalConfigs.clear();
		log("Loading carrier config: "
		+ KEY_CARRIER_APP_NO_WAKE_SIGNAL_CONFIG_STRING_ARRAY);
		parseAndCache(b.getStringArray(KEY_CARRIER_APP_NO_WAKE_SIGNAL_CONFIG_STRING_ARRAY),
		mCachedNoWakeSignalConfigs);
		}
		mCachedCarrierSignalReceiverNames.put(intentAction, receiverNames);
		}
		return receiverNames;
		}

		/**
		* Check if there are registered carrier broadcast receivers to handle any registered intents.
		* Parse each config with the form {pakName./receiverName : signal1, signal2,.} and cached the
		* result internally to avoid repeated polling
		* @see #CARRIER_SIGNAL_DELIMITER
		* @see #COMPONENT_NAME_DELIMITER
		* @param configs raw information from carrier config
		*/
		public boolean hasRegisteredCarrierSignalReceivers() {
		for(String intent : mIntentToCarrierConfigKeyMap.keySet()) {
		if(!ArrayUtils.isEmpty(getCarrierSignalReceiverName(intent))) {
		return true;
		private void parseAndCache(String[] configs,
		Map<String, List<ComponentName>> cachedConfigs) {
		if (!ArrayUtils.isEmpty(configs)) {
		for (String config : configs) {
		if (!TextUtils.isEmpty(config)) {
		String[] splitStr = config.trim().split(COMPONENT_NAME_DELIMITER, 2);
		if (splitStr.length == 2) {
		ComponentName componentName = ComponentName
		.unflattenFromString(splitStr[0]);
		if (componentName == null) {
		loge("Invalid component name: " + splitStr[0]);
		continue;
		}
		String[] signals = splitStr[1].split(CARRIER_SIGNAL_DELIMITER);
		for (String s : signals) {
		s = s.toLowerCase();
		if (!mCarrierSignalList.contains(s)) {
		loge("Invalid signal name: " + s);
		continue;
		}
		List<ComponentName> componentList = cachedConfigs.get(s);
		if (componentList == null) {
		componentList = new ArrayList<>();
		cachedConfigs.put(s, componentList);
		}
		componentList.add(componentName);
		if (VDBG) {
		logv("Add config " + "{signal: " + s
		+ " componentName: " + componentName + "}");
		}
		}
		} else {
		loge("invalid config format: " + config);
		}
		}
		}
		}
		return false;
		}

		public boolean notifyCarrierSignalReceivers(Intent intent) {
		// Read a list of broadcast receivers from carrier config manager
		// which are interested on certain intent type
		String[] receiverName = getCarrierSignalReceiverName(intent.getAction());
		if (receiverName == null) {
		loge("Carrier receiver name is null");
		return false;
		/**
		* Check if there are registered carrier broadcast receivers to handle the passing intent
		*/
		public boolean hasRegisteredReceivers(String action) {
		return mCachedWakeSignalConfigs.containsKey(action.toLowerCase())
		\|\| mCachedNoWakeSignalConfigs.containsKey(action.toLowerCase());
		}

		/**
		* Broadcast the intents explicitly.
		* Some sanity check will be applied before broadcasting.
		* - for non-wakeup(runtime) receivers, make sure the intent is not declared in their manifests
		* and apply FLAG_EXCLUDE_STOPPED_PACKAGES to avoid wake-up
		* - for wakeup(manifest) receivers, make sure there are matched receivers with registered
		* intents.
		*
		* @param intent intent which signals carrier apps
		* @param receivers a list of component name for broadcast receivers.
		* Those receivers could either be statically declared in Manifest or
		* registered during run-time.
		* @param wakeup true indicate wakeup receivers otherwise non-wakeup receivers
		*/
		private void broadcast(Intent intent, List<ComponentName> receivers, boolean wakeup) {
		final PackageManager packageManager = mPhone.getContext().getPackageManager();
		boolean ret = false;
		for (ComponentName name : receivers) {
		Intent signal = new Intent(intent);
		signal.setComponent(name);

		for(String name : receiverName) {
		ComponentName componentName = ComponentName.unflattenFromString(name);
		if (componentName == null) {
		loge("Carrier receiver name could not be parsed");
		return false;
		if (wakeup && packageManager.queryBroadcastReceivers(signal,
		PackageManager.MATCH_DEFAULT_ONLY).isEmpty()) {
		loge("Carrier signal receivers are configured but unavailable: "
		+ signal.getComponent());
		return;
		}
		intent.setComponent(componentName);
		// Check if broadcast receiver is available
		if (packageManager.queryBroadcastReceivers(intent,
		if (!wakeup && !packageManager.queryBroadcastReceivers(signal,
		PackageManager.MATCH_DEFAULT_ONLY).isEmpty()) {
		loge("Carrier signal receiver is configured, but not available: " + name);
		break;
		loge("Runtime signals shouldn't be configured in Manifest: "
		+ signal.getComponent());
		return;
		}

		intent.putExtra(PhoneConstants.SUBSCRIPTION_KEY, mPhone.getSubId());
		intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
		signal.putExtra(PhoneConstants.SUBSCRIPTION_KEY, mPhone.getSubId());
		signal.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
		if (!wakeup) signal.setFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);

		try {
		mPhone.getContext().sendBroadcast(intent);
		if (DBG) log("send Intent to carrier signal receiver with action: " +
		intent.getAction());
		ret = true;
		mPhone.getContext().sendBroadcast(signal);
		if (DBG) {
		log("Sending signal " + signal.getAction() + ((signal.getComponent() != null)
		? " to the carrier signal receiver: " + signal.getComponent() : ""));
		}
		} catch (ActivityNotFoundException e) {
		loge("sendBroadcast failed: " + e);
		loge("Send broadcast failed: " + e);
		}
		}
		}

		return ret;
		/**
		* Match the intent against cached tables to find a list of registered carrier signal
		* receivers and broadcast the intent.
		* @param intent broadcasting intent, it could belong to wakeup, non-wakeup signal list or both
		*
		*/
		public void notifyCarrierSignalReceivers(Intent intent) {
		List<ComponentName> receiverList;

		synchronized (mCachedWakeSignalConfigs) {
		receiverList = mCachedWakeSignalConfigs.get(intent.getAction().toLowerCase());
		if (!ArrayUtils.isEmpty(receiverList)) {
		broadcast(intent, receiverList, WAKE);
		}
		}

		/* Clear cached receiver names */
		public void reset() {
		mCachedCarrierSignalReceiverNames.clear();
		synchronized (mCachedNoWakeSignalConfigs) {
		receiverList = mCachedNoWakeSignalConfigs.get(intent.getAction().toLowerCase());
		if (!ArrayUtils.isEmpty(receiverList)) {
		broadcast(intent, receiverList, NO_WAKE);
		}
		}
		}

		private void log(String s) {
		@@ -161,6 +273,33 @@ public class CarrierSignalAgent {
		}

		private void loge(String s) {
		mErrorLocalLog.log(s);
		Rlog.e(LOG_TAG, "[" + mPhone.getPhoneId() + "]" + s);
		}

		private void logv(String s) {
		Rlog.v(LOG_TAG, "[" + mPhone.getPhoneId() + "]" + s);
		}

		public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
		IndentingPrintWriter ipw = new IndentingPrintWriter(pw, " ");
		pw.println("mCachedWakeSignalConfigs:");
		ipw.increaseIndent();
		for (Map.Entry<String, List<ComponentName>> entry : mCachedWakeSignalConfigs.entrySet()) {
		pw.println("signal: " + entry.getKey() + " componentName list: " + entry.getValue());
		}
		ipw.decreaseIndent();

		pw.println("mCachedNoWakeSignalConfigs:");
		ipw.increaseIndent();
		for (Map.Entry<String, List<ComponentName>> entry : mCachedNoWakeSignalConfigs.entrySet()) {
		pw.println("signal: " + entry.getKey() + " componentName list: " + entry.getValue());
		}
		ipw.decreaseIndent();

		pw.println("error log:");
		ipw.increaseIndent();
		mErrorLocalLog.dump(fd, pw, args);
		ipw.decreaseIndent();
		}
		}

src/java/com/android/internal/telephony/Phone.java

+34 −9

File changed.

Preview size limit exceeded, changes collapsed.

src/java/com/android/internal/telephony/ServiceStateTracker.java

+25 −15

File changed.

Preview size limit exceeded, changes collapsed.

src/java/com/android/internal/telephony/TelephonyComponentFactory.java

+8 −0

Original line number	Diff line number	Diff line
		@@ -68,6 +68,14 @@ public class TelephonyComponentFactory {
		return new DcTracker(phone);
		}

		public CarrierSignalAgent makeCarrierSignalAgent(Phone phone) {
		return new CarrierSignalAgent(phone);
		}

		public CarrierActionAgent makeCarrierActionAgent(Phone phone) {
		return new CarrierActionAgent(phone);
		}

		public IccPhoneBookInterfaceManager makeIccPhoneBookInterfaceManager(Phone phone) {
		return new IccPhoneBookInterfaceManager(phone);
		}