| /* |
| * Copyright (C) 2014 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.server; |
| |
| import android.Manifest.permission; |
| import android.content.BroadcastReceiver; |
| import android.content.ComponentName; |
| import android.content.ContentResolver; |
| import android.content.Context; |
| import android.content.Intent; |
| import android.content.IntentFilter; |
| import android.content.ServiceConnection; |
| import android.content.pm.PackageManager; |
| import android.net.INetworkScoreCache; |
| import android.net.INetworkScoreService; |
| import android.net.NetworkKey; |
| import android.net.NetworkScoreManager; |
| import android.net.NetworkScorerAppManager; |
| import android.net.NetworkScorerAppManager.NetworkScorerAppData; |
| import android.net.RecommendationRequest; |
| import android.net.RecommendationResult; |
| import android.net.ScoredNetwork; |
| import android.net.wifi.WifiConfiguration; |
| import android.os.Binder; |
| import android.os.IBinder; |
| import android.os.RemoteCallbackList; |
| import android.os.RemoteException; |
| import android.os.UserHandle; |
| import android.provider.Settings; |
| import android.text.TextUtils; |
| import android.util.ArrayMap; |
| import android.util.Log; |
| |
| import com.android.internal.R; |
| import com.android.internal.annotations.GuardedBy; |
| import com.android.internal.annotations.VisibleForTesting; |
| import com.android.internal.content.PackageMonitor; |
| import com.android.internal.os.TransferPipe; |
| |
| import java.io.FileDescriptor; |
| import java.io.IOException; |
| import java.io.PrintWriter; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.function.Consumer; |
| |
| /** |
| * Backing service for {@link android.net.NetworkScoreManager}. |
| * @hide |
| */ |
| public class NetworkScoreService extends INetworkScoreService.Stub { |
| private static final String TAG = "NetworkScoreService"; |
| private static final boolean DBG = false; |
| |
| private final Context mContext; |
| private final NetworkScorerAppManager mNetworkScorerAppManager; |
| @GuardedBy("mScoreCaches") |
| private final Map<Integer, RemoteCallbackList<INetworkScoreCache>> mScoreCaches; |
| /** Lock used to update mPackageMonitor when scorer package changes occur. */ |
| private final Object mPackageMonitorLock = new Object[0]; |
| |
| @GuardedBy("mPackageMonitorLock") |
| private NetworkScorerPackageMonitor mPackageMonitor; |
| private ScoringServiceConnection mServiceConnection; |
| |
| private BroadcastReceiver mUserIntentReceiver = new BroadcastReceiver() { |
| @Override |
| public void onReceive(Context context, Intent intent) { |
| final String action = intent.getAction(); |
| final int userId = intent.getIntExtra(Intent.EXTRA_USER_HANDLE, UserHandle.USER_NULL); |
| if (DBG) Log.d(TAG, "Received " + action + " for userId " + userId); |
| if (userId == UserHandle.USER_NULL) return; |
| |
| if (Intent.ACTION_USER_UNLOCKED.equals(action)) { |
| onUserUnlocked(userId); |
| } |
| } |
| }; |
| |
| /** |
| * Clears scores when the active scorer package is no longer valid and |
| * manages the service connection. |
| */ |
| private class NetworkScorerPackageMonitor extends PackageMonitor { |
| final String mRegisteredPackage; |
| |
| private NetworkScorerPackageMonitor(String mRegisteredPackage) { |
| this.mRegisteredPackage = mRegisteredPackage; |
| } |
| |
| @Override |
| public void onPackageAdded(String packageName, int uid) { |
| evaluateBinding(packageName, true /* forceUnbind */); |
| } |
| |
| @Override |
| public void onPackageRemoved(String packageName, int uid) { |
| evaluateBinding(packageName, true /* forceUnbind */); |
| } |
| |
| @Override |
| public void onPackageModified(String packageName) { |
| evaluateBinding(packageName, false /* forceUnbind */); |
| } |
| |
| @Override |
| public boolean onHandleForceStop(Intent intent, String[] packages, int uid, boolean doit) { |
| if (doit) { // "doit" means the force stop happened instead of just being queried for. |
| for (String packageName : packages) { |
| evaluateBinding(packageName, true /* forceUnbind */); |
| } |
| } |
| return super.onHandleForceStop(intent, packages, uid, doit); |
| } |
| |
| @Override |
| public void onPackageUpdateFinished(String packageName, int uid) { |
| evaluateBinding(packageName, true /* forceUnbind */); |
| } |
| |
| private void evaluateBinding(String scorerPackageName, boolean forceUnbind) { |
| if (mRegisteredPackage.equals(scorerPackageName)) { |
| if (DBG) { |
| Log.d(TAG, "Evaluating binding for: " + scorerPackageName |
| + ", forceUnbind=" + forceUnbind); |
| } |
| final NetworkScorerAppData activeScorer = |
| mNetworkScorerAppManager.getActiveScorer(); |
| if (activeScorer == null) { |
| // Package change has invalidated a scorer, this will also unbind any service |
| // connection. |
| Log.i(TAG, "Package " + mRegisteredPackage + |
| " is no longer valid, disabling scoring."); |
| setScorerInternal(null); |
| } else if (activeScorer.mScoringServiceClassName == null) { |
| // The scoring service is not available, make sure it's unbound. |
| unbindFromScoringServiceIfNeeded(); |
| } else { // The scoring service changed in some way. |
| if (forceUnbind) { |
| unbindFromScoringServiceIfNeeded(); |
| } |
| bindToScoringServiceIfNeeded(activeScorer); |
| } |
| } |
| } |
| } |
| |
| public NetworkScoreService(Context context) { |
| this(context, new NetworkScorerAppManager(context)); |
| } |
| |
| @VisibleForTesting |
| NetworkScoreService(Context context, NetworkScorerAppManager networkScoreAppManager) { |
| mContext = context; |
| mNetworkScorerAppManager = networkScoreAppManager; |
| mScoreCaches = new ArrayMap<>(); |
| IntentFilter filter = new IntentFilter(Intent.ACTION_USER_UNLOCKED); |
| // TODO: Need to update when we support per-user scorers. http://b/23422763 |
| mContext.registerReceiverAsUser( |
| mUserIntentReceiver, UserHandle.SYSTEM, filter, null /* broadcastPermission*/, |
| null /* scheduler */); |
| } |
| |
| /** Called when the system is ready to run third-party code but before it actually does so. */ |
| void systemReady() { |
| if (DBG) Log.d(TAG, "systemReady"); |
| ContentResolver cr = mContext.getContentResolver(); |
| if (Settings.Global.getInt(cr, Settings.Global.NETWORK_SCORING_PROVISIONED, 0) == 0) { |
| // On first run, we try to initialize the scorer to the one configured at build time. |
| // This will be a no-op if the scorer isn't actually valid. |
| String defaultPackage = mContext.getResources().getString( |
| R.string.config_defaultNetworkScorerPackageName); |
| if (!TextUtils.isEmpty(defaultPackage)) { |
| mNetworkScorerAppManager.setActiveScorer(defaultPackage); |
| } |
| Settings.Global.putInt(cr, Settings.Global.NETWORK_SCORING_PROVISIONED, 1); |
| } |
| |
| registerPackageMonitorIfNeeded(); |
| } |
| |
| /** Called when the system is ready for us to start third-party code. */ |
| void systemRunning() { |
| if (DBG) Log.d(TAG, "systemRunning"); |
| bindToScoringServiceIfNeeded(); |
| } |
| |
| private void onUserUnlocked(int userId) { |
| registerPackageMonitorIfNeeded(); |
| bindToScoringServiceIfNeeded(); |
| } |
| |
| private void registerPackageMonitorIfNeeded() { |
| if (DBG) Log.d(TAG, "registerPackageMonitorIfNeeded"); |
| NetworkScorerAppData scorer = mNetworkScorerAppManager.getActiveScorer(); |
| synchronized (mPackageMonitorLock) { |
| // Unregister the current monitor if needed. |
| if (mPackageMonitor != null) { |
| if (DBG) { |
| Log.d(TAG, "Unregistering package monitor for " |
| + mPackageMonitor.mRegisteredPackage); |
| } |
| mPackageMonitor.unregister(); |
| mPackageMonitor = null; |
| } |
| |
| // Create and register the monitor if a scorer is active. |
| if (scorer != null) { |
| mPackageMonitor = new NetworkScorerPackageMonitor(scorer.mPackageName); |
| // TODO: Need to update when we support per-user scorers. http://b/23422763 |
| mPackageMonitor.register(mContext, null /* thread */, UserHandle.SYSTEM, |
| false /* externalStorage */); |
| if (DBG) { |
| Log.d(TAG, "Registered package monitor for " |
| + mPackageMonitor.mRegisteredPackage); |
| } |
| } |
| } |
| } |
| |
| private void bindToScoringServiceIfNeeded() { |
| if (DBG) Log.d(TAG, "bindToScoringServiceIfNeeded"); |
| NetworkScorerAppData scorerData = mNetworkScorerAppManager.getActiveScorer(); |
| bindToScoringServiceIfNeeded(scorerData); |
| } |
| |
| private void bindToScoringServiceIfNeeded(NetworkScorerAppData scorerData) { |
| if (DBG) Log.d(TAG, "bindToScoringServiceIfNeeded(" + scorerData + ")"); |
| if (scorerData != null && scorerData.mScoringServiceClassName != null) { |
| ComponentName componentName = |
| new ComponentName(scorerData.mPackageName, scorerData.mScoringServiceClassName); |
| // If we're connected to a different component then drop it. |
| if (mServiceConnection != null |
| && !mServiceConnection.mComponentName.equals(componentName)) { |
| unbindFromScoringServiceIfNeeded(); |
| } |
| |
| // If we're not connected at all then create a new connection. |
| if (mServiceConnection == null) { |
| mServiceConnection = new ScoringServiceConnection(componentName); |
| } |
| |
| // Make sure the connection is connected (idempotent) |
| mServiceConnection.connect(mContext); |
| } else { // otherwise make sure it isn't bound. |
| unbindFromScoringServiceIfNeeded(); |
| } |
| } |
| |
| private void unbindFromScoringServiceIfNeeded() { |
| if (DBG) Log.d(TAG, "unbindFromScoringServiceIfNeeded"); |
| if (mServiceConnection != null) { |
| mServiceConnection.disconnect(mContext); |
| } |
| mServiceConnection = null; |
| } |
| |
| @Override |
| public boolean updateScores(ScoredNetwork[] networks) { |
| if (!mNetworkScorerAppManager.isCallerActiveScorer(getCallingUid())) { |
| throw new SecurityException("Caller with UID " + getCallingUid() + |
| " is not the active scorer."); |
| } |
| |
| // Separate networks by type. |
| Map<Integer, List<ScoredNetwork>> networksByType = new ArrayMap<>(); |
| for (ScoredNetwork network : networks) { |
| List<ScoredNetwork> networkList = networksByType.get(network.networkKey.type); |
| if (networkList == null) { |
| networkList = new ArrayList<>(); |
| networksByType.put(network.networkKey.type, networkList); |
| } |
| networkList.add(network); |
| } |
| |
| // Pass the scores of each type down to the appropriate network scorer. |
| for (final Map.Entry<Integer, List<ScoredNetwork>> entry : networksByType.entrySet()) { |
| final RemoteCallbackList<INetworkScoreCache> callbackList; |
| final boolean isEmpty; |
| synchronized (mScoreCaches) { |
| callbackList = mScoreCaches.get(entry.getKey()); |
| isEmpty = callbackList == null || callbackList.getRegisteredCallbackCount() == 0; |
| } |
| if (isEmpty) { |
| if (Log.isLoggable(TAG, Log.VERBOSE)) { |
| Log.v(TAG, "No scorer registered for type " + entry.getKey() + ", discarding"); |
| } |
| continue; |
| } |
| |
| sendCallback(new Consumer<INetworkScoreCache>() { |
| @Override |
| public void accept(INetworkScoreCache networkScoreCache) { |
| try { |
| networkScoreCache.updateScores(entry.getValue()); |
| } catch (RemoteException e) { |
| if (Log.isLoggable(TAG, Log.VERBOSE)) { |
| Log.v(TAG, "Unable to update scores of type " + entry.getKey(), e); |
| } |
| } |
| } |
| }, Collections.singleton(callbackList)); |
| } |
| |
| return true; |
| } |
| |
| @Override |
| public boolean clearScores() { |
| // Only the active scorer or the system (who can broadcast BROADCAST_NETWORK_PRIVILEGED) |
| // should be allowed to flush all scores. |
| if (mNetworkScorerAppManager.isCallerActiveScorer(getCallingUid()) || |
| mContext.checkCallingOrSelfPermission(permission.BROADCAST_NETWORK_PRIVILEGED) == |
| PackageManager.PERMISSION_GRANTED) { |
| clearInternal(); |
| return true; |
| } else { |
| throw new SecurityException( |
| "Caller is neither the active scorer nor the scorer manager."); |
| } |
| } |
| |
| @Override |
| public boolean setActiveScorer(String packageName) { |
| // TODO: For now, since SCORE_NETWORKS requires an app to be privileged, we allow such apps |
| // to directly set the scorer app rather than having to use the consent dialog. The |
| // assumption is that anyone bundling a scorer app with the system is trusted by the OEM to |
| // do the right thing and not enable this feature without explaining it to the user. |
| // In the future, should this API be opened to 3p apps, we will need to lock this down and |
| // figure out another way to streamline the UX. |
| |
| // mContext.enforceCallingOrSelfPermission(permission.BROADCAST_NETWORK_PRIVILEGED, TAG); |
| mContext.enforceCallingOrSelfPermission(permission.SCORE_NETWORKS, TAG); |
| |
| return setScorerInternal(packageName); |
| } |
| |
| @Override |
| public void disableScoring() { |
| // Only the active scorer or the system (who can broadcast BROADCAST_NETWORK_PRIVILEGED) |
| // should be allowed to disable scoring. |
| if (mNetworkScorerAppManager.isCallerActiveScorer(getCallingUid()) || |
| mContext.checkCallingOrSelfPermission(permission.BROADCAST_NETWORK_PRIVILEGED) == |
| PackageManager.PERMISSION_GRANTED) { |
| // The return value is discarded here because at this point, the call should always |
| // succeed. The only reason for failure is if the new package is not a valid scorer, but |
| // we're disabling scoring altogether here. |
| setScorerInternal(null /* packageName */); |
| } else { |
| throw new SecurityException( |
| "Caller is neither the active scorer nor the scorer manager."); |
| } |
| } |
| |
| /** Set the active scorer. Callers are responsible for checking permissions as appropriate. */ |
| private boolean setScorerInternal(String packageName) { |
| if (DBG) Log.d(TAG, "setScorerInternal(" + packageName + ")"); |
| long token = Binder.clearCallingIdentity(); |
| try { |
| unbindFromScoringServiceIfNeeded(); |
| // Preemptively clear scores even though the set operation could fail. We do this for |
| // safety as scores should never be compared across apps; in practice, Settings should |
| // only be allowing valid apps to be set as scorers, so failure here should be rare. |
| clearInternal(); |
| // Get the scorer that is about to be replaced, if any, so we can notify it directly. |
| NetworkScorerAppData prevScorer = mNetworkScorerAppManager.getActiveScorer(); |
| boolean result = mNetworkScorerAppManager.setActiveScorer(packageName); |
| // Unconditionally attempt to bind to the current scorer. If setActiveScorer() failed |
| // then we'll attempt to restore the previous binding (if any), otherwise an attempt |
| // will be made to bind to the new scorer. |
| bindToScoringServiceIfNeeded(); |
| if (result) { // new scorer successfully set |
| registerPackageMonitorIfNeeded(); |
| |
| Intent intent = new Intent(NetworkScoreManager.ACTION_SCORER_CHANGED); |
| if (prevScorer != null) { // Directly notify the old scorer. |
| intent.setPackage(prevScorer.mPackageName); |
| // TODO: Need to update when we support per-user scorers. http://b/23422763 |
| mContext.sendBroadcastAsUser(intent, UserHandle.SYSTEM); |
| } |
| |
| if (packageName != null) { // Then notify the new scorer |
| intent.putExtra(NetworkScoreManager.EXTRA_NEW_SCORER, packageName); |
| intent.setPackage(packageName); |
| // TODO: Need to update when we support per-user scorers. http://b/23422763 |
| mContext.sendBroadcastAsUser(intent, UserHandle.SYSTEM); |
| } |
| } |
| return result; |
| } finally { |
| Binder.restoreCallingIdentity(token); |
| } |
| } |
| |
| /** Clear scores. Callers are responsible for checking permissions as appropriate. */ |
| private void clearInternal() { |
| sendCallback(new Consumer<INetworkScoreCache>() { |
| @Override |
| public void accept(INetworkScoreCache networkScoreCache) { |
| try { |
| networkScoreCache.clearScores(); |
| } catch (RemoteException e) { |
| if (Log.isLoggable(TAG, Log.VERBOSE)) { |
| Log.v(TAG, "Unable to clear scores", e); |
| } |
| } |
| } |
| }, getScoreCacheLists()); |
| } |
| |
| @Override |
| public void registerNetworkScoreCache(int networkType, |
| INetworkScoreCache scoreCache, |
| int filterType) { |
| mContext.enforceCallingOrSelfPermission(permission.BROADCAST_NETWORK_PRIVILEGED, TAG); |
| synchronized (mScoreCaches) { |
| RemoteCallbackList<INetworkScoreCache> callbackList = mScoreCaches.get(networkType); |
| if (callbackList == null) { |
| callbackList = new RemoteCallbackList<>(); |
| mScoreCaches.put(networkType, callbackList); |
| } |
| if (!callbackList.register(scoreCache, filterType)) { |
| if (callbackList.getRegisteredCallbackCount() == 0) { |
| mScoreCaches.remove(networkType); |
| } |
| if (Log.isLoggable(TAG, Log.VERBOSE)) { |
| Log.v(TAG, "Unable to register NetworkScoreCache for type " + networkType); |
| } |
| } |
| } |
| } |
| |
| @Override |
| public void unregisterNetworkScoreCache(int networkType, INetworkScoreCache scoreCache) { |
| mContext.enforceCallingOrSelfPermission(permission.BROADCAST_NETWORK_PRIVILEGED, TAG); |
| synchronized (mScoreCaches) { |
| RemoteCallbackList<INetworkScoreCache> callbackList = mScoreCaches.get(networkType); |
| if (callbackList == null || !callbackList.unregister(scoreCache)) { |
| if (Log.isLoggable(TAG, Log.VERBOSE)) { |
| Log.v(TAG, "Unable to unregister NetworkScoreCache for type " + networkType); |
| } |
| } else if (callbackList.getRegisteredCallbackCount() == 0) { |
| mScoreCaches.remove(networkType); |
| } |
| } |
| } |
| |
| @Override |
| public RecommendationResult requestRecommendation(RecommendationRequest request) { |
| // TODO(jjoslin): 11/25/16 - Update with real impl. |
| WifiConfiguration selectedConfig = null; |
| if (request != null) { |
| selectedConfig = request.getCurrentSelectedConfig(); |
| } |
| return new RecommendationResult(selectedConfig); |
| } |
| |
| @Override |
| public boolean requestScores(NetworkKey[] networks) { |
| // TODO(jjoslin): 12/13/16 - Implement |
| return false; |
| } |
| |
| @Override |
| protected void dump(final FileDescriptor fd, final PrintWriter writer, final String[] args) { |
| mContext.enforceCallingOrSelfPermission(permission.DUMP, TAG); |
| NetworkScorerAppData currentScorer = mNetworkScorerAppManager.getActiveScorer(); |
| if (currentScorer == null) { |
| writer.println("Scoring is disabled."); |
| return; |
| } |
| writer.println("Current scorer: " + currentScorer.mPackageName); |
| |
| sendCallback(new Consumer<INetworkScoreCache>() { |
| @Override |
| public void accept(INetworkScoreCache networkScoreCache) { |
| try { |
| TransferPipe.dumpAsync(networkScoreCache.asBinder(), fd, args); |
| } catch (IOException | RemoteException e) { |
| writer.println("Failed to dump score cache: " + e); |
| } |
| } |
| }, getScoreCacheLists()); |
| |
| if (mServiceConnection != null) { |
| mServiceConnection.dump(fd, writer, args); |
| } else { |
| writer.println("ScoringServiceConnection: null"); |
| } |
| writer.flush(); |
| } |
| |
| /** |
| * Returns a {@link Collection} of all {@link RemoteCallbackList}s that are currently active. |
| * |
| * <p>May be used to perform an action on all score caches without potentially strange behavior |
| * if a new scorer is registered during that action's execution. |
| */ |
| private Collection<RemoteCallbackList<INetworkScoreCache>> getScoreCacheLists() { |
| synchronized (mScoreCaches) { |
| return new ArrayList<>(mScoreCaches.values()); |
| } |
| } |
| |
| private void sendCallback(Consumer<INetworkScoreCache> consumer, |
| Collection<RemoteCallbackList<INetworkScoreCache>> remoteCallbackLists) { |
| for (RemoteCallbackList<INetworkScoreCache> callbackList : remoteCallbackLists) { |
| synchronized (callbackList) { // Ensure only one active broadcast per RemoteCallbackList |
| final int count = callbackList.beginBroadcast(); |
| try { |
| for (int i = 0; i < count; i++) { |
| consumer.accept(callbackList.getBroadcastItem(i)); |
| } |
| } finally { |
| callbackList.finishBroadcast(); |
| } |
| } |
| } |
| } |
| |
| private static class ScoringServiceConnection implements ServiceConnection { |
| private final ComponentName mComponentName; |
| private boolean mBound = false; |
| private boolean mConnected = false; |
| |
| ScoringServiceConnection(ComponentName componentName) { |
| mComponentName = componentName; |
| } |
| |
| void connect(Context context) { |
| if (!mBound) { |
| Intent service = new Intent(); |
| service.setComponent(mComponentName); |
| mBound = context.bindServiceAsUser(service, this, |
| Context.BIND_AUTO_CREATE | Context.BIND_FOREGROUND_SERVICE, |
| UserHandle.SYSTEM); |
| if (!mBound) { |
| Log.w(TAG, "Bind call failed for " + service); |
| } else { |
| if (DBG) Log.d(TAG, "ScoringServiceConnection bound."); |
| } |
| } |
| } |
| |
| void disconnect(Context context) { |
| try { |
| if (mBound) { |
| mBound = false; |
| context.unbindService(this); |
| if (DBG) Log.d(TAG, "ScoringServiceConnection unbound."); |
| } |
| } catch (RuntimeException e) { |
| Log.e(TAG, "Unbind failed.", e); |
| } |
| } |
| |
| @Override |
| public void onServiceConnected(ComponentName name, IBinder service) { |
| if (DBG) Log.d(TAG, "ScoringServiceConnection: " + name.flattenToString()); |
| mConnected = true; |
| } |
| |
| @Override |
| public void onServiceDisconnected(ComponentName name) { |
| if (DBG) { |
| Log.d(TAG, "ScoringServiceConnection, disconnected: " + name.flattenToString()); |
| } |
| mConnected = false; |
| } |
| |
| public void dump(FileDescriptor fd, PrintWriter writer, String[] args) { |
| writer.println("ScoringServiceConnection: " + mComponentName + ", bound: " + mBound |
| + ", connected: " + mConnected); |
| } |
| } |
| } |