Partially Revert "DynamicDenylistManager shall not exist"
This is required by SettingsGoogle fuel gauge. This reverts commit da270f9fa1383b6717d6a872dc90eac8a6783c27. Signed-off-by: Pranav Vashi <neobuddy89@gmail.com>
This commit is contained in:
Pranav Vashi
@@ -0,0 +1,260 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2023 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.settings.fuelgauge.datasaver;
|
||||||
|
|
||||||
|
import static android.net.NetworkPolicyManager.POLICY_NONE;
|
||||||
|
import static android.net.NetworkPolicyManager.POLICY_REJECT_METERED_BACKGROUND;
|
||||||
|
|
||||||
|
import static com.android.settings.Utils.SETTINGS_PACKAGE_NAME;
|
||||||
|
|
||||||
|
import android.content.Context;
|
||||||
|
import android.content.SharedPreferences;
|
||||||
|
import android.content.pm.PackageManager;
|
||||||
|
import android.net.NetworkPolicyManager;
|
||||||
|
import android.util.ArraySet;
|
||||||
|
import android.util.Log;
|
||||||
|
|
||||||
|
import androidx.annotation.VisibleForTesting;
|
||||||
|
|
||||||
|
import java.io.PrintWriter;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Set;
|
||||||
|
|
||||||
|
/** A class to dynamically manage per apps {@link NetworkPolicyManager} POLICY_ flags. */
|
||||||
|
public class DynamicDenylistManager {
|
||||||
|
|
||||||
|
private static final String TAG = "DynamicDenylistManager";
|
||||||
|
private static final String PREF_KEY_MANUAL_DENY = "manual_denylist_preference";
|
||||||
|
private static final String PREF_KEY_DYNAMIC_DENY = "dynamic_denylist_preference";
|
||||||
|
|
||||||
|
@VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
|
||||||
|
public static DynamicDenylistManager sInstance = null;
|
||||||
|
|
||||||
|
private final Context mContext;
|
||||||
|
private final NetworkPolicyManager mNetworkPolicyManager;
|
||||||
|
private final Object mLock = new Object();
|
||||||
|
|
||||||
|
@VisibleForTesting
|
||||||
|
static final String PREF_KEY_MANUAL_DENYLIST_SYNCED = "manual_denylist_synced";
|
||||||
|
|
||||||
|
/** @return a DynamicDenylistManager object */
|
||||||
|
public static DynamicDenylistManager getInstance(Context context) {
|
||||||
|
synchronized (DynamicDenylistManager.class) {
|
||||||
|
if (sInstance == null) {
|
||||||
|
sInstance = new DynamicDenylistManager(
|
||||||
|
context, NetworkPolicyManager.from(context));
|
||||||
|
}
|
||||||
|
return sInstance;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@VisibleForTesting
|
||||||
|
DynamicDenylistManager(Context context, NetworkPolicyManager networkPolicyManager) {
|
||||||
|
mContext = context.getApplicationContext();
|
||||||
|
mNetworkPolicyManager = networkPolicyManager;
|
||||||
|
syncPolicyIfNeeded();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Sync the policy from {@link NetworkPolicyManager} if needed. */
|
||||||
|
private void syncPolicyIfNeeded() {
|
||||||
|
if (getManualDenylistPref().contains(PREF_KEY_MANUAL_DENYLIST_SYNCED)) {
|
||||||
|
Log.i(TAG, "syncPolicyIfNeeded() ignore synced manual denylist");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
final SharedPreferences.Editor editor = getManualDenylistPref().edit();
|
||||||
|
final int[] existedUids = mNetworkPolicyManager
|
||||||
|
.getUidsWithPolicy(POLICY_REJECT_METERED_BACKGROUND);
|
||||||
|
if (existedUids != null && existedUids.length != 0) {
|
||||||
|
for (int uid : existedUids) {
|
||||||
|
editor.putInt(String.valueOf(uid), POLICY_REJECT_METERED_BACKGROUND);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
editor.putInt(PREF_KEY_MANUAL_DENYLIST_SYNCED, POLICY_NONE).apply();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Set policy flags for specific UID. */
|
||||||
|
public void setUidPolicyLocked(int uid, int policy) {
|
||||||
|
Log.i(TAG, "setUidPolicyLocked: uid=" + uid + " policy=" + policy);
|
||||||
|
synchronized (mLock) {
|
||||||
|
mNetworkPolicyManager.setUidPolicy(uid, policy);
|
||||||
|
}
|
||||||
|
updateDenylistPref(uid, policy);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Suggest a list of package to set as POLICY_REJECT. */
|
||||||
|
public void setDenylist(Set<Integer> denylistTargetUids) {
|
||||||
|
if (denylistTargetUids == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
final Set<Integer> manualDenylistUids = getDenylistAllUids(getManualDenylistPref());
|
||||||
|
denylistTargetUids.removeAll(manualDenylistUids);
|
||||||
|
|
||||||
|
final Set<Integer> lastDynamicDenylistUids = getDenylistAllUids(getDynamicDenylistPref());
|
||||||
|
if (lastDynamicDenylistUids.equals(denylistTargetUids)) {
|
||||||
|
Log.i(TAG, "setDenylist() ignore the same denylist with size: "
|
||||||
|
+ lastDynamicDenylistUids.size());
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
final ArraySet<Integer> failedUids = new ArraySet<>();
|
||||||
|
synchronized (mLock) {
|
||||||
|
// Set new added UIDs into REJECT policy.
|
||||||
|
for (Integer uidInteger : denylistTargetUids) {
|
||||||
|
if (uidInteger == null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
final int uid = uidInteger.intValue();
|
||||||
|
if (!lastDynamicDenylistUids.contains(uid)) {
|
||||||
|
try {
|
||||||
|
mNetworkPolicyManager.setUidPolicy(uid, POLICY_REJECT_METERED_BACKGROUND);
|
||||||
|
} catch (Exception e) {
|
||||||
|
Log.e(TAG, "failed to setUidPolicy(REJECT) for " + uid, e);
|
||||||
|
failedUids.add(uid);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Unset removed UIDs back to NONE policy.
|
||||||
|
for (int uid : lastDynamicDenylistUids) {
|
||||||
|
if (!denylistTargetUids.contains(uid)) {
|
||||||
|
try {
|
||||||
|
mNetworkPolicyManager.setUidPolicy(uid, POLICY_NONE);
|
||||||
|
} catch (Exception e) {
|
||||||
|
Log.e(TAG, "failed to setUidPolicy(NONE) for " + uid, e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store target denied uids into DynamicDenylistPref.
|
||||||
|
final SharedPreferences.Editor editor = getDynamicDenylistPref().edit();
|
||||||
|
editor.clear();
|
||||||
|
denylistTargetUids.forEach(uid -> {
|
||||||
|
if (!failedUids.contains(uid)) {
|
||||||
|
editor.putInt(String.valueOf(uid), POLICY_REJECT_METERED_BACKGROUND);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
editor.apply();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Return true if the target uid is in {@link #getManualDenylistPref()}. */
|
||||||
|
public boolean isInManualDenylist(int uid) {
|
||||||
|
return getManualDenylistPref().contains(String.valueOf(uid));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reset the UIDs in the denylist if needed. */
|
||||||
|
public void resetDenylistIfNeeded(String packageName, boolean force) {
|
||||||
|
if (!force && !SETTINGS_PACKAGE_NAME.equals(packageName)) {
|
||||||
|
Log.w(TAG, "resetDenylistIfNeeded: invalid conditions");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
synchronized (mLock) {
|
||||||
|
final int[] uids = mNetworkPolicyManager
|
||||||
|
.getUidsWithPolicy(POLICY_REJECT_METERED_BACKGROUND);
|
||||||
|
if (uids != null && uids.length != 0) {
|
||||||
|
Log.i(TAG, "resetDenylistIfNeeded: " + Arrays.toString(uids));
|
||||||
|
for (int uid : uids) {
|
||||||
|
if (!getDenylistAllUids(getManualDenylistPref()).contains(uid)) {
|
||||||
|
mNetworkPolicyManager.setUidPolicy(uid, POLICY_NONE);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
Log.w(TAG, "resetDenylistIfNeeded: there is no valid UIDs");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
clearSharedPreferences();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reset the POLICY_REJECT_METERED uids when device is boot completed. */
|
||||||
|
public void onBootComplete() {
|
||||||
|
resetDenylistIfNeeded(/* packageName= */ null, /* force= */ true);
|
||||||
|
syncPolicyIfNeeded();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Dump the data stored in the {@link SharedPreferences}. */
|
||||||
|
public void dump(PrintWriter writer) {
|
||||||
|
writer.println("Dump of DynamicDenylistManager:");
|
||||||
|
final List<String> manualDenyList =
|
||||||
|
getPackageNames(mContext, getDenylistAllUids(getManualDenylistPref()));
|
||||||
|
writer.println("\tManualDenylist:");
|
||||||
|
if (manualDenyList != null) {
|
||||||
|
manualDenyList.forEach(packageName -> writer.println("\t\t" + packageName));
|
||||||
|
writer.flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
final List<String> dynamicDenyList =
|
||||||
|
getPackageNames(mContext, getDenylistAllUids(getDynamicDenylistPref()));
|
||||||
|
writer.println("\tDynamicDenylist:");
|
||||||
|
if (dynamicDenyList != null) {
|
||||||
|
dynamicDenyList.forEach(packageName -> writer.println("\t\t" + packageName));
|
||||||
|
writer.flush();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private Set<Integer> getDenylistAllUids(SharedPreferences sharedPreferences) {
|
||||||
|
final ArraySet<Integer> uids = new ArraySet<>();
|
||||||
|
for (String key : sharedPreferences.getAll().keySet()) {
|
||||||
|
if (PREF_KEY_MANUAL_DENYLIST_SYNCED.equals(key)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
uids.add(Integer.parseInt(key));
|
||||||
|
} catch (NumberFormatException e) {
|
||||||
|
Log.e(TAG, "getDenylistAllUids() unexpected format for " + key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return uids;
|
||||||
|
}
|
||||||
|
|
||||||
|
void updateDenylistPref(int uid, int policy) {
|
||||||
|
final String uidString = String.valueOf(uid);
|
||||||
|
if (policy != POLICY_REJECT_METERED_BACKGROUND) {
|
||||||
|
getManualDenylistPref().edit().remove(uidString).apply();
|
||||||
|
} else {
|
||||||
|
getManualDenylistPref().edit().putInt(uidString, policy).apply();
|
||||||
|
}
|
||||||
|
getDynamicDenylistPref().edit().remove(uidString).apply();
|
||||||
|
}
|
||||||
|
|
||||||
|
void clearSharedPreferences() {
|
||||||
|
Log.i(TAG, "clearSharedPreferences()");
|
||||||
|
getManualDenylistPref().edit().clear().apply();
|
||||||
|
getDynamicDenylistPref().edit().clear().apply();
|
||||||
|
}
|
||||||
|
|
||||||
|
@VisibleForTesting
|
||||||
|
SharedPreferences getManualDenylistPref() {
|
||||||
|
return mContext.getSharedPreferences(PREF_KEY_MANUAL_DENY, Context.MODE_PRIVATE);
|
||||||
|
}
|
||||||
|
|
||||||
|
@VisibleForTesting
|
||||||
|
SharedPreferences getDynamicDenylistPref() {
|
||||||
|
return mContext.getSharedPreferences(PREF_KEY_DYNAMIC_DENY, Context.MODE_PRIVATE);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static List<String> getPackageNames(Context context, Set<Integer> uids) {
|
||||||
|
if (uids == null || uids.isEmpty()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
final PackageManager pm = context.getPackageManager();
|
||||||
|
final List<String> packageNames = new ArrayList<>(uids.size());
|
||||||
|
uids.forEach(uid -> packageNames.add(pm.getNameForUid(uid)));
|
||||||
|
return packageNames;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user