Merge "Copy DatabaseUtils from SettingsGoogle to Settings and use the new Settings database." (b036cfab) · Commits · e / os / android_packages_apps_Settings

src/com/android/settings/fuelgauge/batteryusage/DatabaseUtils.java

+298 −1

Original line number	Diff line number	Diff line
		@@ -15,22 +15,319 @@
		*/

		package com.android.settings.fuelgauge.batteryusage;

		import android.content.ComponentName;
		import android.content.ContentResolver;
		import android.content.ContentValues;
		import android.content.Context;
		import android.content.Intent;
		import android.content.IntentFilter;
		import android.content.SharedPreferences;
		import android.content.pm.PackageManager;
		import android.database.Cursor;
		import android.net.Uri;
		import android.os.BatteryManager;
		import android.os.BatteryUsageStats;
		import android.os.Handler;
		import android.os.Looper;
		import android.os.SystemClock;
		import android.os.UserHandle;
		import android.os.UserManager;
		import android.util.Log;

		import androidx.annotation.VisibleForTesting;

		import com.android.settingslib.fuelgauge.BatteryStatus;

		import java.time.Clock;
		import java.time.Duration;
		import java.util.ArrayList;
		import java.util.Calendar;
		import java.util.HashMap;
		import java.util.List;
		import java.util.Map;

		/** A utility class to operate battery usage database. */
		public final class DatabaseUtils {
		private static final String TAG = "DatabaseUtils";
		private static final String PREF_FILE_NAME = "battery_module_preference";
		private static final String PREF_FULL_CHARGE_TIMESTAMP_KEY = "last_full_charge_timestamp_key";
		/ Key for query parameter timestamp used in BATTERY_CONTENT_URI /
		private static final String QUERY_KEY_TIMESTAMP = "timestamp";
		/ Clear memory threshold for device booting phase. /
		private static final long CLEAR_MEMORY_THRESHOLD_MS = Duration.ofMinutes(5).toMillis();
		private static final long CLEAR_MEMORY_DELAYED_MS = Duration.ofSeconds(2).toMillis();

		/** An authority name of the battery content provider. */
		public static final String AUTHORITY = "com.android.settings.battery.usage.provider";
		/** A table name for battery usage history. */
		public static final String BATTERY_STATE_TABLE = "BatteryState";
		/** A class name for battery usage data provider. */
		public static final String SETTINGS_PACKAGE_PATH = "com.android.settings";
		public static final String BATTERY_PROVIDER_CLASS_PATH =
		"com.android.settings.fuelgauge.batteryusage.BatteryUsageContentProvider";

		/** A content URI to access battery usage states data. */
		public static final Uri BATTERY_CONTENT_URI =
		new Uri.Builder()
		.scheme(ContentResolver.SCHEME_CONTENT)
		.authority(AUTHORITY)
		.appendPath(BATTERY_STATE_TABLE)
		.build();

		private DatabaseUtils() {
		}

		/** Returns true if current user is a work profile user. */
		public static boolean isWorkProfile(Context context) {
		final UserManager userManager = context.getSystemService(UserManager.class);
		return userManager.isManagedProfile() && !userManager.isSystemUser();
		}

		/** Returns true if the chart graph design is enabled. */
		public static boolean isChartGraphEnabled(Context context) {
		return isContentProviderEnabled(context);
		}

		/** Long: for timestamp and String: for BatteryHistEntry.getKey() */
		public static Map<Long, Map<String, BatteryHistEntry>> getHistoryMapSinceLastFullCharge(
		Context context, Calendar calendar) {
		final long startTime = System.currentTimeMillis();
		final long lastFullChargeTimestamp =
		getStartTimestampForLastFullCharge(context, calendar);
		// Builds the content uri everytime to avoid cache.
		final Uri batteryStateUri =
		new Uri.Builder()
		.scheme(ContentResolver.SCHEME_CONTENT)
		.authority(AUTHORITY)
		.appendPath(BATTERY_STATE_TABLE)
		.appendQueryParameter(
		QUERY_KEY_TIMESTAMP, Long.toString(lastFullChargeTimestamp))
		.build();

		final Map<Long, Map<String, BatteryHistEntry>> resultMap =
		loadHistoryMapFromContentProvider(context, batteryStateUri);
		if (resultMap == null \|\| resultMap.isEmpty()) {
		Log.d(TAG, "getHistoryMapSinceLastFullCharge() returns empty or null");
		} else {
		Log.d(TAG, String.format("getHistoryMapSinceLastFullCharge() size=%d in %d/ms",
		resultMap.size(), (System.currentTimeMillis() - startTime)));
		}
		return resultMap;
		}

		static boolean isContentProviderEnabled(Context context) {
		return context.getPackageManager()
		.getComponentEnabledSetting(
		new ComponentName(SETTINGS_PACKAGE_PATH, BATTERY_PROVIDER_CLASS_PATH))
		== PackageManager.COMPONENT_ENABLED_STATE_ENABLED;
		}

		static List<ContentValues> sendBatteryEntryData(
		Context context,
		List<BatteryEntry> batteryEntryList,
		BatteryUsageStats batteryUsageStats) {
		final long startTime = System.currentTimeMillis();
		final Intent intent = getBatteryIntent(context);
		if (intent == null) {
		Log.e(TAG, "sendBatteryEntryData(): cannot fetch battery intent");
		clearMemory();
		return null;
		}
		final int batteryLevel = getBatteryLevel(intent);
		final int batteryStatus = intent.getIntExtra(
		BatteryManager.EXTRA_STATUS, BatteryManager.BATTERY_STATUS_UNKNOWN);
		final int batteryHealth = intent.getIntExtra(
		BatteryManager.EXTRA_HEALTH, BatteryManager.BATTERY_HEALTH_UNKNOWN);
		// We should use the same timestamp for each data snapshot.
		final long snapshotTimestamp = Clock.systemUTC().millis();
		final long snapshotBootTimestamp = SystemClock.elapsedRealtime();

		// Creates the ContentValues list to insert them into provider.
		final List<ContentValues> valuesList = new ArrayList<>();
		if (batteryEntryList != null) {
		batteryEntryList.stream()
		.filter(entry -> {
		final long foregroundMs = entry.getTimeInForegroundMs();
		final long backgroundMs = entry.getTimeInBackgroundMs();
		if (entry.getConsumedPower() == 0
		&& (foregroundMs != 0 \|\| backgroundMs != 0)) {
		Log.w(TAG, String.format(
		"no consumed power but has running time for %s time=%d\|%d",
		entry.getLabel(), foregroundMs, backgroundMs));
		}
		return entry.getConsumedPower() != 0
		\|\| foregroundMs != 0
		\|\| backgroundMs != 0;
		})
		.forEach(entry -> valuesList.add(
		ConvertUtils.convertToContentValues(
		entry,
		batteryUsageStats,
		batteryLevel,
		batteryStatus,
		batteryHealth,
		snapshotBootTimestamp,
		snapshotTimestamp)));
		}

		int size = 1;
		final ContentResolver resolver = context.getContentResolver();
		// Inserts all ContentValues into battery provider.
		if (!valuesList.isEmpty()) {
		final ContentValues[] valuesArray = new ContentValues[valuesList.size()];
		valuesList.toArray(valuesArray);
		try {
		size = resolver.bulkInsert(BATTERY_CONTENT_URI, valuesArray);
		} catch (Exception e) {
		Log.e(TAG, "bulkInsert() data into database error:\n" + e);
		}
		} else {
		// Inserts one fake data into battery provider.
		final ContentValues contentValues =
		ConvertUtils.convertToContentValues(
		/entry=/ null,
		/batteryUsageStats=/ null,
		batteryLevel,
		batteryStatus,
		batteryHealth,
		snapshotBootTimestamp,
		snapshotTimestamp);
		try {
		resolver.insert(BATTERY_CONTENT_URI, contentValues);
		} catch (Exception e) {
		Log.e(TAG, "insert() data into database error:\n" + e);
		}
		valuesList.add(contentValues);
		}
		saveLastFullChargeTimestampPref(context, batteryStatus, batteryLevel, snapshotTimestamp);
		resolver.notifyChange(BATTERY_CONTENT_URI, /observer=/ null);
		Log.d(TAG, String.format("sendBatteryEntryData() size=%d in %d/ms",
		size, (System.currentTimeMillis() - startTime)));
		clearMemory();
		return valuesList;
		}

		@VisibleForTesting
		static void saveLastFullChargeTimestampPref(
		Context context, int batteryStatus, int batteryLevel, long timestamp) {
		// Updates the SharedPreference only when timestamp is valid and phone is full charge.
		if (!BatteryStatus.isCharged(batteryStatus, batteryLevel)) {
		return;
		}

		final boolean success =
		getSharedPreferences(context)
		.edit()
		.putLong(PREF_FULL_CHARGE_TIMESTAMP_KEY, timestamp)
		.commit();
		if (!success) {
		Log.w(TAG, "saveLastFullChargeTimestampPref() fail: value=" + timestamp);
		}
		}

		@VisibleForTesting
		static long getLastFullChargeTimestampPref(Context context) {
		return getSharedPreferences(context).getLong(PREF_FULL_CHARGE_TIMESTAMP_KEY, 0);
		}

		/**
		* Returns the start timestamp for "since last full charge" battery usage chart.
		* If the last full charge happens within the last 7 days, returns the timestamp of last full
		* charge. Otherwise, returns the timestamp for 00:00 6 days before the calendar date.
		*/
		@VisibleForTesting
		static long getStartTimestampForLastFullCharge(
		Context context, Calendar calendar) {
		final long lastFullChargeTimestamp = getLastFullChargeTimestampPref(context);
		final long sixDayAgoTimestamp = getTimestampSixDaysAgo(calendar);
		return Math.max(lastFullChargeTimestamp, sixDayAgoTimestamp);
		}

		private static Map<Long, Map<String, BatteryHistEntry>> loadHistoryMapFromContentProvider(
		Context context, Uri batteryStateUri) {
		final boolean isWorkProfileUser = isWorkProfile(context);
		Log.d(TAG, "loadHistoryMapFromContentProvider() isWorkProfileUser:" + isWorkProfileUser);
		if (isWorkProfileUser) {
		try {
		context = context.createPackageContextAsUser(
		/packageName=/ context.getPackageName(),
		/flags=/ 0,
		/user=/ UserHandle.OWNER);
		} catch (PackageManager.NameNotFoundException e) {
		Log.e(TAG, "context.createPackageContextAsUser() fail:" + e);
		return null;
		}
		}
		if (!isContentProviderEnabled(context)) {
		return null;
		}
		final Map<Long, Map<String, BatteryHistEntry>> resultMap = new HashMap();
		try (Cursor cursor =
		context.getContentResolver().query(batteryStateUri, null, null, null)) {
		if (cursor == null \|\| cursor.getCount() == 0) {
		return resultMap;
		}
		// Loads and recovers all BatteryHistEntry data from cursor.
		while (cursor.moveToNext()) {
		final BatteryHistEntry entry = new BatteryHistEntry(cursor);
		final long timestamp = entry.mTimestamp;
		final String key = entry.getKey();
		Map batteryHistEntryMap = resultMap.get(timestamp);
		// Creates new one if there is no corresponding map.
		if (batteryHistEntryMap == null) {
		batteryHistEntryMap = new HashMap<>();
		resultMap.put(timestamp, batteryHistEntryMap);
		}
		batteryHistEntryMap.put(key, entry);
		}
		}
		return resultMap;
		}

		/** Gets the latest sticky battery intent from framework. */
		private static Intent getBatteryIntent(Context context) {
		return context.registerReceiver(
		/receiver=/ null, new IntentFilter(Intent.ACTION_BATTERY_CHANGED));
		}

		private static int getBatteryLevel(Intent intent) {
		final int level = intent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1);
		final int scale = intent.getIntExtra(BatteryManager.EXTRA_SCALE, 0);
		return scale == 0
		? -1 /invalid battery level/
		: Math.round((level / (float) scale) * 100f);
		}

		private static void clearMemory() {
		if (SystemClock.uptimeMillis() > CLEAR_MEMORY_THRESHOLD_MS) {
		return;
		}
		final Handler mainHandler = new Handler(Looper.getMainLooper());
		mainHandler.postDelayed(() -> {
		System.gc();
		System.runFinalization();
		System.gc();
		Log.w(TAG, "invoke clearMemory()");
		}, CLEAR_MEMORY_DELAYED_MS);
		}

		private static SharedPreferences getSharedPreferences(Context context) {
		return context
		.getApplicationContext() // ensures we bind it with application
		.createDeviceProtectedStorageContext()
		.getSharedPreferences(PREF_FILE_NAME, Context.MODE_PRIVATE);
		}

		/** Returns the timestamp for 00:00 6 days before the calendar date. */
		private static long getTimestampSixDaysAgo(Calendar calendar) {
		Calendar startCalendar =
		calendar == null ? Calendar.getInstance() : (Calendar) calendar.clone();
		startCalendar.add(Calendar.DAY_OF_YEAR, -6);
		startCalendar.set(Calendar.HOUR_OF_DAY, 0);
		startCalendar.set(Calendar.MINUTE, 0);
		startCalendar.set(Calendar.SECOND, 0);
		startCalendar.set(Calendar.MILLISECOND, 0);
		return startCalendar.getTimeInMillis();
		}

		}

tests/robotests/src/com/android/settings/fuelgauge/batteryusage/BatteryUsageContentProviderTest.java

+1 −6

Original line number	Diff line number	Diff line
		@@ -44,12 +44,7 @@ import java.util.List;
		/** Tests for {@link BatteryUsageContentProvider}. */
		@RunWith(RobolectricTestRunner.class)
		public final class BatteryUsageContentProviderTest {
		private static final Uri VALID_BATTERY_STATE_CONTENT_URI =
		new Uri.Builder()
		.scheme(ContentResolver.SCHEME_CONTENT)
		.authority(DatabaseUtils.AUTHORITY)
		.appendPath(DatabaseUtils.BATTERY_STATE_TABLE)
		.build();
		private static final Uri VALID_BATTERY_STATE_CONTENT_URI = DatabaseUtils.BATTERY_CONTENT_URI;

		private Context mContext;
		private BatteryUsageContentProvider mProvider;

tests/robotests/src/com/android/settings/fuelgauge/batteryusage/DatabaseUtilsTest.java

0 → 100644

+422 −0

File added.

Preview size limit exceeded, changes collapsed.