1/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License
15 */
16
17package android.net;
18
19import android.Manifest;
20import android.annotation.SdkConstant;
21import android.annotation.SdkConstant.SdkConstantType;
22import android.annotation.SystemApi;
23import android.content.Context;
24import android.content.Intent;
25import android.net.NetworkScorerAppManager.NetworkScorerAppData;
26import android.os.IBinder;
27import android.os.RemoteException;
28import android.os.ServiceManager;
29import android.os.UserHandle;
30
31/**
32 * Class that manages communication between network subsystems and a network scorer.
33 *
34 * <p>You can get an instance of this class by calling
35 * {@link android.content.Context#getSystemService(String)}:
36 *
37 * <pre>NetworkScoreManager manager =
38 *     (NetworkScoreManager) getSystemService(Context.NETWORK_SCORE_SERVICE)</pre>
39 *
40 * <p>A network scorer is any application which:
41 * <ul>
42 * <li>Declares the {@link android.Manifest.permission#SCORE_NETWORKS} permission.
43 * <li>Includes a receiver for {@link #ACTION_SCORE_NETWORKS} guarded by the
44 *     {@link android.Manifest.permission#BROADCAST_NETWORK_PRIVILEGED} permission which scores
45 *     networks and (eventually) calls {@link #updateScores} with the results. If this receiver
46 *     specifies an android:label attribute, this label will be used when referring to the
47 *     application throughout system settings; otherwise, the application label will be used.
48 * </ul>
49 *
50 * <p>The system keeps track of an active scorer application; at any time, only this application
51 * will receive {@link #ACTION_SCORE_NETWORKS} broadcasts and will be permitted to call
52 * {@link #updateScores}. Applications may determine the current active scorer with
53 * {@link #getActiveScorerPackage()} and request to change the active scorer by sending an
54 * {@link #ACTION_CHANGE_ACTIVE} broadcast with another scorer.
55 *
56 * @hide
57 */
58@SystemApi
59public class NetworkScoreManager {
60    /**
61     * Activity action: ask the user to change the active network scorer. This will show a dialog
62     * that asks the user whether they want to replace the current active scorer with the one
63     * specified in {@link #EXTRA_PACKAGE_NAME}. The activity will finish with RESULT_OK if the
64     * active scorer was changed or RESULT_CANCELED if it failed for any reason.
65     */
66    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
67    public static final String ACTION_CHANGE_ACTIVE = "android.net.scoring.CHANGE_ACTIVE";
68
69    /**
70     * Extra used with {@link #ACTION_CHANGE_ACTIVE} to specify the new scorer package. Set with
71     * {@link android.content.Intent#putExtra(String, String)}.
72     */
73    public static final String EXTRA_PACKAGE_NAME = "packageName";
74
75    /**
76     * Broadcast action: new network scores are being requested. This intent will only be delivered
77     * to the current active scorer app. That app is responsible for scoring the networks and
78     * calling {@link #updateScores} when complete. The networks to score are specified in
79     * {@link #EXTRA_NETWORKS_TO_SCORE}, and will generally consist of all networks which have been
80     * configured by the user as well as any open networks.
81     *
82     * <p class="note">This is a protected intent that can only be sent by the system.
83     */
84    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
85    public static final String ACTION_SCORE_NETWORKS = "android.net.scoring.SCORE_NETWORKS";
86
87    /**
88     * Extra used with {@link #ACTION_SCORE_NETWORKS} to specify the networks to be scored, as an
89     * array of {@link NetworkKey}s. Can be obtained with
90     * {@link android.content.Intent#getParcelableArrayExtra(String)}}.
91     */
92    public static final String EXTRA_NETWORKS_TO_SCORE = "networksToScore";
93
94    /**
95     * Activity action: launch a custom activity for configuring a scorer before enabling it.
96     * Scorer applications may choose to specify an activity for this action, in which case the
97     * framework will launch that activity which should return RESULT_OK if scoring was enabled.
98     *
99     * <p>If no activity is included in a scorer which implements this action, the system dialog for
100     * selecting a scorer will be shown instead.
101     */
102    @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
103    public static final String ACTION_CUSTOM_ENABLE = "android.net.scoring.CUSTOM_ENABLE";
104
105    /**
106     * Broadcast action: the active scorer has been changed. Scorer apps may listen to this to
107     * perform initialization once selected as the active scorer, or clean up unneeded resources
108     * if another scorer has been selected. Note that it is unnecessary to clear existing scores as
109     * this is handled by the system.
110     *
111     * <p>The new scorer will be specified in {@link #EXTRA_NEW_SCORER}.
112     *
113     * <p class="note">This is a protected intent that can only be sent by the system.
114     */
115    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
116    public static final String ACTION_SCORER_CHANGED = "android.net.scoring.SCORER_CHANGED";
117
118    /**
119     * Extra used with {@link #ACTION_SCORER_CHANGED} to specify the newly selected scorer's package
120     * name. Will be null if scoring was disabled. Can be obtained with
121     * {@link android.content.Intent#getStringExtra(String)}.
122     */
123    public static final String EXTRA_NEW_SCORER = "newScorer";
124
125    private final Context mContext;
126    private final INetworkScoreService mService;
127
128    /** @hide */
129    public NetworkScoreManager(Context context) {
130        mContext = context;
131        IBinder iBinder = ServiceManager.getService(Context.NETWORK_SCORE_SERVICE);
132        mService = INetworkScoreService.Stub.asInterface(iBinder);
133    }
134
135    /**
136     * Obtain the package name of the current active network scorer.
137     *
138     * <p>At any time, only one scorer application will receive {@link #ACTION_SCORE_NETWORKS}
139     * broadcasts and be allowed to call {@link #updateScores}. Applications may use this method to
140     * determine the current scorer and offer the user the ability to select a different scorer via
141     * the {@link #ACTION_CHANGE_ACTIVE} intent.
142     * @return the full package name of the current active scorer, or null if there is no active
143     *         scorer.
144     */
145    public String getActiveScorerPackage() {
146        NetworkScorerAppData app = NetworkScorerAppManager.getActiveScorer(mContext);
147        if (app == null) {
148            return null;
149        }
150        return app.mPackageName;
151    }
152
153    /**
154     * Update network scores.
155     *
156     * <p>This may be called at any time to re-score active networks. Scores will generally be
157     * updated quickly, but if this method is called too frequently, the scores may be held and
158     * applied at a later time.
159     *
160     * @param networks the networks which have been scored by the scorer.
161     * @return whether the update was successful.
162     * @throws SecurityException if the caller is not the active scorer.
163     */
164    public boolean updateScores(ScoredNetwork[] networks) throws SecurityException {
165        try {
166            return mService.updateScores(networks);
167        } catch (RemoteException e) {
168            return false;
169        }
170    }
171
172    /**
173     * Clear network scores.
174     *
175     * <p>Should be called when all scores need to be invalidated, i.e. because the scoring
176     * algorithm has changed and old scores can no longer be compared to future scores.
177     *
178     * <p>Note that scores will be cleared automatically when the active scorer changes, as scores
179     * from one scorer cannot be compared to those from another scorer.
180     *
181     * @return whether the clear was successful.
182     * @throws SecurityException if the caller is not the active scorer or privileged.
183     */
184    public boolean clearScores() throws SecurityException {
185        try {
186            return mService.clearScores();
187        } catch (RemoteException e) {
188            return false;
189        }
190    }
191
192    /**
193     * Set the active scorer to a new package and clear existing scores.
194     *
195     * <p>Should never be called directly without obtaining user consent. This can be done by using
196     * the {@link #ACTION_CHANGE_ACTIVE} broadcast, or using a custom configuration activity.
197     *
198     * @return true if the operation succeeded, or false if the new package is not a valid scorer.
199     * @throws SecurityException if the caller does not hold the
200     *         {@link android.Manifest.permission#SCORE_NETWORKS} permission.
201     * @hide
202     */
203    @SystemApi
204    public boolean setActiveScorer(String packageName) throws SecurityException {
205        try {
206            return mService.setActiveScorer(packageName);
207        } catch (RemoteException e) {
208            return false;
209        }
210    }
211
212    /**
213     * Turn off network scoring.
214     *
215     * <p>May only be called by the current scorer app, or the system.
216     *
217     * @throws SecurityException if the caller is neither the active scorer nor the system.
218     */
219    public void disableScoring() throws SecurityException {
220        try {
221            mService.disableScoring();
222        } catch (RemoteException e) {
223        }
224    }
225
226    /**
227     * Request scoring for networks.
228     *
229     * <p>Note that this is just a helper method to assemble the broadcast, and will run in the
230     * calling process.
231     *
232     * @return true if the broadcast was sent, or false if there is no active scorer.
233     * @throws SecurityException if the caller does not hold the
234     *         {@link android.Manifest.permission#BROADCAST_NETWORK_PRIVILEGED} permission.
235     * @hide
236     */
237    public boolean requestScores(NetworkKey[] networks) throws SecurityException {
238        String activeScorer = getActiveScorerPackage();
239        if (activeScorer == null) {
240            return false;
241        }
242        Intent intent = new Intent(ACTION_SCORE_NETWORKS);
243        intent.setPackage(activeScorer);
244        intent.setFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT);
245        intent.putExtra(EXTRA_NETWORKS_TO_SCORE, networks);
246        // A scorer should never become active if its package doesn't hold SCORE_NETWORKS, but
247        // ensure the package still holds it to be extra safe.
248        mContext.sendBroadcastAsUser(intent, UserHandle.OWNER, Manifest.permission.SCORE_NETWORKS);
249        return true;
250    }
251
252    /**
253     * Register a network score cache.
254     *
255     * @param networkType the type of network this cache can handle. See {@link NetworkKey#type}.
256     * @param scoreCache implementation of {@link INetworkScoreCache} to store the scores.
257     * @throws SecurityException if the caller does not hold the
258     *         {@link android.Manifest.permission#BROADCAST_NETWORK_PRIVILEGED} permission.
259     * @throws IllegalArgumentException if a score cache is already registered for this type.
260     * @hide
261     */
262    public void registerNetworkScoreCache(int networkType, INetworkScoreCache scoreCache) {
263        try {
264            mService.registerNetworkScoreCache(networkType, scoreCache);
265        } catch (RemoteException e) {
266        }
267    }
268}
269