Create data store for safe search preference.

Test: atest SupervisionSafeSearchPreferenceTest
Test: atest SupervisionWebContentFiltersScreenTest
Test: manually tested with physical device
Flag: android.app.supervision.flags.enable_web_content_filters_screen
Bug: 401568995
Change-Id: Ia9e3f73ac6e9efbe7933dc2958443e9fdb5b4422
This commit is contained in:
Xiaomiao Zhang
2025-03-17 21:15:09 +00:00
parent 2897cf5def
commit b7de2ba4a5
5 changed files with 177 additions and 17 deletions

View File

@@ -0,0 +1,71 @@
/*
* Copyright (C) 2025 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.supervision
import android.content.Context
import android.provider.Settings.Secure.SEARCH_CONTENT_FILTERS_ENABLED
import com.android.settingslib.datastore.AbstractKeyedDataObservable
import com.android.settingslib.datastore.HandlerExecutor
import com.android.settingslib.datastore.KeyValueStore
import com.android.settingslib.datastore.KeyedObserver
import com.android.settingslib.datastore.SettingsSecureStore
import com.android.settingslib.datastore.SettingsStore
/** Datastore of the safe search preference. */
@Suppress("UNCHECKED_CAST")
class SupervisionSafeSearchDataStore(
private val context: Context,
private val settingsStore: SettingsStore = SettingsSecureStore.get(context),
) : AbstractKeyedDataObservable<String>(), KeyedObserver<String>, KeyValueStore {
override fun contains(key: String) =
key == SupervisionSearchFilterOnPreference.KEY ||
key == SupervisionSearchFilterOffPreference.KEY
override fun <T : Any> getValue(key: String, valueType: Class<T>): T? {
val settingValue = (settingsStore.getBoolean(SEARCH_CONTENT_FILTERS_ENABLED) == true)
return when (key) {
SupervisionSearchFilterOffPreference.KEY -> !settingValue
SupervisionSearchFilterOnPreference.KEY -> settingValue
else -> null
}
as T?
}
override fun <T : Any> setValue(key: String, valueType: Class<T>, value: T?) {
if (value !is Boolean) return
when (key) {
SupervisionSearchFilterOffPreference.KEY ->
settingsStore.setBoolean(SEARCH_CONTENT_FILTERS_ENABLED, !value)
SupervisionSearchFilterOnPreference.KEY ->
settingsStore.setBoolean(SEARCH_CONTENT_FILTERS_ENABLED, value)
}
}
override fun onFirstObserverAdded() {
// observe the underlying storage key
settingsStore.addObserver(SEARCH_CONTENT_FILTERS_ENABLED, this, HandlerExecutor.main)
}
override fun onKeyChanged(key: String, reason: Int) {
// forward data change to preference hierarchy key
notifyChange(SupervisionSearchFilterOffPreference.KEY, reason)
notifyChange(SupervisionSearchFilterOnPreference.KEY, reason)
}
override fun onLastObserverRemoved() {
settingsStore.removeObserver(SEARCH_CONTENT_FILTERS_ENABLED, this)
}
}

View File

@@ -18,9 +18,7 @@ package com.android.settings.supervision
import android.content.Context
import androidx.preference.Preference
import com.android.settings.R
import com.android.settingslib.datastore.KeyValueStore
import com.android.settingslib.datastore.Permissions
import com.android.settingslib.datastore.SettingsSecureStore
import com.android.settingslib.metadata.BooleanValuePreference
import com.android.settingslib.metadata.PreferenceMetadata
import com.android.settingslib.metadata.ReadWritePermit
@@ -30,9 +28,10 @@ import com.android.settingslib.preference.forEachRecursively
import com.android.settingslib.widget.SelectorWithWidgetPreference
/** Base class of web content filters SafeSearch preferences. */
sealed class SupervisionSafeSearchPreference :
BooleanValuePreference, SelectorWithWidgetPreference.OnClickListener, PreferenceBinding {
override fun storage(context: Context): KeyValueStore = SettingsSecureStore.get(context)
sealed class SupervisionSafeSearchPreference(
protected val dataStore: SupervisionSafeSearchDataStore
) : BooleanValuePreference, SelectorWithWidgetPreference.OnClickListener, PreferenceBinding {
override fun storage(context: Context) = dataStore
override fun getReadPermissions(context: Context) = Permissions.EMPTY
@@ -64,15 +63,15 @@ sealed class SupervisionSafeSearchPreference :
override fun bind(preference: Preference, metadata: PreferenceMetadata) {
super.bind(preference, metadata)
(preference as SelectorWithWidgetPreference).also {
// TODO(b/401568995): Set the isChecked value using stored values.
it.isChecked = (it.key == SupervisionSearchFilterOffPreference.KEY)
it.isChecked = (dataStore.getBoolean(it.key) == true)
it.setOnClickListener(this)
}
}
}
/** The SafeSearch filter on preference. */
class SupervisionSearchFilterOnPreference : SupervisionSafeSearchPreference() {
class SupervisionSearchFilterOnPreference(dataStore: SupervisionSafeSearchDataStore) :
SupervisionSafeSearchPreference(dataStore) {
override val key
get() = KEY
@@ -89,7 +88,8 @@ class SupervisionSearchFilterOnPreference : SupervisionSafeSearchPreference() {
}
/** The SafeSearch filter off preference. */
class SupervisionSearchFilterOffPreference : SupervisionSafeSearchPreference() {
class SupervisionSearchFilterOffPreference(dataStore: SupervisionSafeSearchDataStore) :
SupervisionSafeSearchPreference(dataStore) {
override val key
get() = KEY

View File

@@ -56,8 +56,9 @@ class SupervisionWebContentFiltersScreen : PreferenceScreenCreator {
R.string.supervision_web_content_filters_search_title,
) +=
{
+SupervisionSearchFilterOnPreference()
+SupervisionSearchFilterOffPreference()
val dataStore = SupervisionSafeSearchDataStore(context)
+SupervisionSearchFilterOnPreference(dataStore)
+SupervisionSearchFilterOffPreference(dataStore)
}
}