PawletOS/app_Settings
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

No-op refactor on EmergencyGesturePreferenceController.

Browse Source 
Move custom intent launching logic into a separate controller
(EmergencyGestureEntrypointPreferenceController).

This is in preparation of a mini-IA refresh and fixing a search
bug. The custom intent logic is only needed by the entrypoint
pref, and putting in the gesture PrefControler makes any fix
hard to implement.

Bug: 171067360
Bug: 172609395
Test: RunSettingsRoboTests
Change-Id: I1e26393872bfada98db80a1cc33e3e13dacb086b
This commit is contained in:
Fan Zhang
2020-11-12 14:15:20 -08:00
parent 76eb401911
commit d7c833278b
9 changed files with 314 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
res/layout/emergency_gesture_switch_bar.xml Normal file
View File

@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
~ Copyright (C) 2020 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.
-->
<!-- For use in a LayoutPreference -->
<LinearLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_height="wrap_content"
android:layout_width="match_parent"
android:orientation="vertical">
<com.android.settings.widget.SwitchBar
android:id="@+id/switch_bar"
android:minHeight="?android:attr/actionBarSize"
android:layout_height="wrap_content"
android:layout_width="match_parent"
android:paddingStart="0dp"
android:theme="?attr/switchBarTheme"/>
<TextView
android:layout_height="wrap_content"
android:layout_width="match_parent"
android:layout_marginStart="@dimen/actionbar_subsettings_contentInsetStart"
android:layout_marginVertical="16dp"
android:text="@string/emergency_gesture_screen_summary"/>
</LinearLayout>

11
res/xml/emergency_gesture_settings.xml
View File

@@ -25,14 +25,11 @@
app:animation="@raw/gesture_double_tap"
app:preview="@drawable/gesture_double_tap"/>
<SwitchPreference
android:key="gesture_emergency_button"
android:title="@string/emergency_gesture_screen_title"
android:summary="@string/emergency_gesture_screen_summary"
android:icon="@drawable/ic_hand_gesture"
app:keywords="@string/keywords_gesture"
<com.android.settingslib.widget.LayoutPreference
android:key="gesture_emergency_button_switch_bar"
android:layout="@layout/emergency_gesture_switch_bar"
app:controller="com.android.settings.gestures.EmergencyGesturePreferenceController"
app:allowDividerAbove="true"/>
app:allowDividerBelow="true"/>
<SwitchPreference
android:key="emergency_gesture_sound"

2
res/xml/gestures.xml
View File

@@ -24,7 +24,7 @@
android:key="gesture_emergency_summary"
android:title="@string/emergency_gesture_screen_title"
android:fragment="com.android.settings.gestures.EmergencyGestureSettings"
settings:controller="com.android.settings.gestures.EmergencyGesturePreferenceController" />
settings:controller="com.android.settings.gestures.EmergencyGestureEntrypointPreferenceController" />
<Preference
android:key="gesture_assist_input_summary"

125
src/com/android/settings/gestures/EmergencyGestureEntrypointPreferenceController.java Normal file
View File

@@ -0,0 +1,125 @@
/*
* Copyright (C) 2020 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.gestures;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.text.TextUtils;
import android.util.Log;
import androidx.annotation.VisibleForTesting;
import androidx.preference.Preference;
import com.android.settings.R;
import com.android.settings.core.BasePreferenceController;
/**
* Preference controller for emergency gesture setting's entyrpoint preference
*/
public class EmergencyGestureEntrypointPreferenceController extends BasePreferenceController {
private static final String TAG = "EmergencyGestureEntry";
@VisibleForTesting
static final String ACTION_EMERGENCY_GESTURE_SETTINGS =
"com.android.settings.action.emergency_gesture_settings";
@VisibleForTesting
Intent mIntent;
private boolean mUseCustomIntent;
public EmergencyGestureEntrypointPreferenceController(Context context, String key) {
super(context, key);
final String emergencyGestureSettingsPackageName = context.getResources().getString(
R.string.emergency_gesture_settings_package);
if (!TextUtils.isEmpty(emergencyGestureSettingsPackageName)) {
mUseCustomIntent = true;
// Use custom intent if it's configured and system can resolve it.
final Intent intent = new Intent(ACTION_EMERGENCY_GESTURE_SETTINGS)
.setPackage(emergencyGestureSettingsPackageName);
if (canResolveIntent(intent)) {
mIntent = intent;
}
}
}
@Override
public void updateState(Preference preference) {
super.updateState(preference);
final boolean canHandleClicks = !mUseCustomIntent || mIntent != null;
if (preference != null) {
preference.setEnabled(canHandleClicks);
}
}
@Override
public boolean handlePreferenceTreeClick(Preference preference) {
if (TextUtils.equals(getPreferenceKey(), preference.getKey()) && mIntent != null) {
mIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
mContext.startActivity(mIntent);
return true;
}
return super.handlePreferenceTreeClick(preference);
}
@Override
public int getAvailabilityStatus() {
final boolean isConfigEnabled = mContext.getResources()
.getBoolean(R.bool.config_show_emergency_gesture_settings);
if (!isConfigEnabled) {
return UNSUPPORTED_ON_DEVICE;
}
return AVAILABLE;
}
@Override
public CharSequence getSummary() {
if (mUseCustomIntent) {
final String packageName = mContext.getResources().getString(
R.string.emergency_gesture_settings_package);
try {
final PackageManager pm = mContext.getPackageManager();
final ApplicationInfo appInfo = pm.getApplicationInfo(
packageName, PackageManager.MATCH_DISABLED_COMPONENTS
| PackageManager.MATCH_DISABLED_UNTIL_USED_COMPONENTS);
return mContext.getString(R.string.emergency_gesture_entrypoint_summary,
appInfo.loadLabel(pm));
} catch (Exception e) {
Log.d(TAG, "Failed to get custom summary, falling back.");
return super.getSummary();
}
}
return super.getSummary();
}
/**
* Whether or not gesture page content should be suppressed from search.
*/
public boolean shouldSuppressFromSearch() {
return mUseCustomIntent;
}
private boolean canResolveIntent(Intent intent) {
final ResolveInfo resolveActivity = mContext.getPackageManager()
.resolveActivity(intent, 0);
return resolveActivity != null;
}
}

110
src/com/android/settings/gestures/EmergencyGesturePreferenceController.java
View File

@@ -17,64 +17,34 @@
package com.android.settings.gestures;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.provider.Settings;
import android.text.TextUtils;
import android.util.Log;
import android.widget.Switch;
import androidx.annotation.VisibleForTesting;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settings.core.BasePreferenceController;
import com.android.settings.widget.SwitchBar;
import com.android.settingslib.widget.LayoutPreference;
/**
* Preference controller for emergency gesture setting
*/
public class EmergencyGesturePreferenceController extends GesturePreferenceController {
private static final String TAG = "EmergencyGesturePref";
public class EmergencyGesturePreferenceController extends BasePreferenceController implements
SwitchBar.OnSwitchChangeListener {
@VisibleForTesting
static final int ON = 1;
@VisibleForTesting
static final int OFF = 0;
@VisibleForTesting
static final String ACTION_EMERGENCY_GESTURE_SETTINGS =
"com.android.settings.action.emergency_gesture_settings";
@VisibleForTesting
Intent mIntent;
private boolean mUseCustomIntent;
private static final String PREF_KEY_VIDEO = "emergency_gesture_screen_video";
private static final String SECURE_KEY = Settings.Secure.EMERGENCY_GESTURE_ENABLED;
private SwitchBar mSwitchBar;
public EmergencyGesturePreferenceController(Context context, String key) {
super(context, key);
final String emergencyGestureSettingsPackageName = context.getResources().getString(
R.string.emergency_gesture_settings_package);
if (!TextUtils.isEmpty(emergencyGestureSettingsPackageName)) {
mUseCustomIntent = true;
// Use custom intent if it's configured and system can resolve it.
final Intent intent = new Intent(ACTION_EMERGENCY_GESTURE_SETTINGS)
.setPackage(emergencyGestureSettingsPackageName);
if (canResolveIntent(intent)) {
mIntent = intent;
}
}
}
@Override
public boolean handlePreferenceTreeClick(Preference preference) {
if (TextUtils.equals(getPreferenceKey(), preference.getKey()) && mIntent != null) {
mIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
mContext.startActivity(mIntent);
return true;
}
return super.handlePreferenceTreeClick(preference);
}
@Override
@@ -89,62 +59,24 @@ public class EmergencyGesturePreferenceController extends GesturePreferenceContr
}
@Override
public boolean isSliceable() {
return TextUtils.equals(getPreferenceKey(), "gesture_emergency_button");
public void displayPreference(PreferenceScreen screen) {
super.displayPreference(screen);
final LayoutPreference pref = screen.findPreference(mPreferenceKey);
mSwitchBar = pref.findViewById(R.id.switch_bar);
mSwitchBar.setSwitchBarText(R.string.emergency_gesture_screen_title,
R.string.emergency_gesture_screen_title);
mSwitchBar.addOnSwitchChangeListener(this);
mSwitchBar.setChecked(isChecked());
mSwitchBar.show();
}
@Override
protected boolean canHandleClicks() {
return !mUseCustomIntent || mIntent != null;
}
@Override
public CharSequence getSummary() {
if (mUseCustomIntent) {
final String packageName = mContext.getResources().getString(
R.string.emergency_gesture_settings_package);
try {
final PackageManager pm = mContext.getPackageManager();
final ApplicationInfo appInfo = pm.getApplicationInfo(
packageName, PackageManager.MATCH_DISABLED_COMPONENTS
| PackageManager.MATCH_DISABLED_UNTIL_USED_COMPONENTS);
return mContext.getString(R.string.emergency_gesture_entrypoint_summary,
appInfo.loadLabel(pm));
} catch (Exception e) {
Log.d(TAG, "Failed to get custom summary, falling back.");
return super.getSummary();
}
}
return super.getSummary();
}
@Override
protected String getVideoPrefKey() {
return PREF_KEY_VIDEO;
}
@Override
@VisibleForTesting
public boolean isChecked() {
return Settings.Secure.getInt(mContext.getContentResolver(), SECURE_KEY, OFF) == ON;
}
@Override
public boolean setChecked(boolean isChecked) {
return Settings.Secure.putInt(mContext.getContentResolver(), SECURE_KEY,
isChecked ? ON : OFF);
}
/**
* Whether or not gesture page content should be suppressed from search.
*/
public boolean shouldSuppressFromSearch() {
return mUseCustomIntent;
}
private boolean canResolveIntent(Intent intent) {
final ResolveInfo resolveActivity = mContext.getPackageManager()
.resolveActivity(intent, 0);
return resolveActivity != null;
public void onSwitchChanged(Switch switchView, boolean isChecked) {
Settings.Secure.putInt(mContext.getContentResolver(), SECURE_KEY, isChecked ? ON : OFF);
}
}

4
src/com/android/settings/gestures/EmergencyGestureSettings.java
View File

@@ -51,8 +51,8 @@ public class EmergencyGestureSettings extends DashboardFragment {
new BaseSearchIndexProvider(R.xml.emergency_gesture_settings) {
@Override
protected boolean isPageSearchEnabled(Context context) {
final EmergencyGesturePreferenceController controller =
new EmergencyGesturePreferenceController(context,
final EmergencyGestureEntrypointPreferenceController controller =
new EmergencyGestureEntrypointPreferenceController(context,
"dummy_emergency_gesture_pref_key");
return !controller.isAvailable()
|| controller.shouldSuppressFromSearch();

8
src/com/android/settings/gestures/EmergencyGestureSoundPreferenceController.java
View File

@@ -22,12 +22,11 @@ import android.provider.Settings;
import androidx.annotation.VisibleForTesting;
import com.android.settings.R;
import com.android.settings.core.TogglePreferenceController;
/**
* Preference controller for emergency sos gesture setting
*/
public class EmergencyGestureSoundPreferenceController extends TogglePreferenceController {
public class EmergencyGestureSoundPreferenceController extends GesturePreferenceController {
@VisibleForTesting
static final int ON = 1;
@@ -40,6 +39,11 @@ public class EmergencyGestureSoundPreferenceController extends TogglePreferenceC
super(context, key);
}
@Override
protected String getVideoPrefKey() {
return "emergency_gesture_screen_video";
}
private static boolean isGestureAvailable(Context context) {
return context.getResources()
.getBoolean(R.bool.config_show_emergency_gesture_settings);

109
tests/robotests/src/com/android/settings/gestures/EmergencyGestureEntrypointPreferenceControllerTest.java Normal file
View File

@@ -0,0 +1,109 @@
/*
* Copyright (C) 2020 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.gestures;
import static com.android.settings.core.BasePreferenceController.AVAILABLE;
import static com.android.settings.core.BasePreferenceController.UNSUPPORTED_ON_DEVICE;
import static com.android.settings.gestures.EmergencyGestureEntrypointPreferenceController.ACTION_EMERGENCY_GESTURE_SETTINGS;
import static com.google.common.truth.Truth.assertThat;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.ResolveInfo;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.R;
import com.android.settings.testutils.shadow.SettingsShadowResources;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.Shadows;
import org.robolectric.annotation.Config;
import org.robolectric.shadows.ShadowPackageManager;
@RunWith(RobolectricTestRunner.class)
@Config(shadows = SettingsShadowResources.class)
public class EmergencyGestureEntrypointPreferenceControllerTest {
private static final String TEST_PKG_NAME = "test_pkg";
private static final String TEST_CLASS_NAME = "name";
private static final Intent SETTING_INTENT = new Intent(ACTION_EMERGENCY_GESTURE_SETTINGS)
.setPackage(TEST_PKG_NAME);
private Context mContext;
private ShadowPackageManager mPackageManager;
private EmergencyGestureEntrypointPreferenceController mController;
private static final String PREF_KEY = "gesture_emergency_button";
@Before
public void setUp() {
mContext = ApplicationProvider.getApplicationContext();
mPackageManager = Shadows.shadowOf(mContext.getPackageManager());
mController = new EmergencyGestureEntrypointPreferenceController(mContext, PREF_KEY);
}
@After
public void tearDown() {
SettingsShadowResources.reset();
}
@Test
public void constructor_hasCustomPackageConfig_shouldSetIntent() {
final ResolveInfo info = new ResolveInfo();
info.activityInfo = new ActivityInfo();
info.activityInfo.packageName = TEST_PKG_NAME;
info.activityInfo.name = TEST_CLASS_NAME;
mPackageManager.addResolveInfoForIntent(SETTING_INTENT, info);
SettingsShadowResources.overrideResource(
R.bool.config_show_emergency_gesture_settings,
Boolean.TRUE);
SettingsShadowResources.overrideResource(
R.string.emergency_gesture_settings_package,
TEST_PKG_NAME);
mController = new EmergencyGestureEntrypointPreferenceController(mContext, PREF_KEY);
assertThat(mController.mIntent).isNotNull();
}
@Test
public void getAvailabilityStatus_configIsTrue_shouldReturnAvailable() {
SettingsShadowResources.overrideResource(
R.bool.config_show_emergency_gesture_settings,
Boolean.TRUE);
assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
}
@Test
public void getAvailabilityStatus_configIsFalse_shouldReturnUnsupported() {
SettingsShadowResources.overrideResource(
R.bool.config_show_emergency_gesture_settings,
Boolean.FALSE);
assertThat(mController.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE);
}
}

59
tests/robotests/src/com/android/settings/gestures/EmergencyGesturePreferenceControllerTest.java
View File

@@ -16,7 +16,8 @@
package com.android.settings.gestures;
import static com.android.settings.gestures.EmergencyGesturePreferenceController.ACTION_EMERGENCY_GESTURE_SETTINGS;
import static com.android.settings.core.BasePreferenceController.AVAILABLE;
import static com.android.settings.core.BasePreferenceController.UNSUPPORTED_ON_DEVICE;
import static com.android.settings.gestures.EmergencyGesturePreferenceController.OFF;
import static com.android.settings.gestures.EmergencyGesturePreferenceController.ON;
@@ -24,9 +25,6 @@ import static com.google.common.truth.Truth.assertThat;
import android.content.ContentResolver;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.ResolveInfo;
import android.provider.Settings;
import androidx.test.core.app.ApplicationProvider;
@@ -39,22 +37,14 @@ import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.Shadows;
import org.robolectric.annotation.Config;
import org.robolectric.shadows.ShadowPackageManager;
@RunWith(RobolectricTestRunner.class)
@Config(shadows = SettingsShadowResources.class)
public class EmergencyGesturePreferenceControllerTest {
private static final String TEST_PKG_NAME = "test_pkg";
private static final String TEST_CLASS_NAME = "name";
private static final Intent SETTING_INTENT = new Intent(ACTION_EMERGENCY_GESTURE_SETTINGS)
.setPackage(TEST_PKG_NAME);
private Context mContext;
private ContentResolver mContentResolver;
private ShadowPackageManager mPackageManager;
private EmergencyGesturePreferenceController mController;
private static final String PREF_KEY = "gesture_emergency_button";
@@ -62,7 +52,6 @@ public class EmergencyGesturePreferenceControllerTest {
public void setUp() {
mContext = ApplicationProvider.getApplicationContext();
mContentResolver = mContext.getContentResolver();
mPackageManager = Shadows.shadowOf(mContext.getPackageManager());
mController = new EmergencyGesturePreferenceController(mContext, PREF_KEY);
}
@@ -72,43 +61,21 @@ public class EmergencyGesturePreferenceControllerTest {
}
@Test
public void constructor_hasCustomPackageConfig_shouldSetIntent() {
final ResolveInfo info = new ResolveInfo();
info.activityInfo = new ActivityInfo();
info.activityInfo.packageName = TEST_PKG_NAME;
info.activityInfo.name = TEST_CLASS_NAME;
mPackageManager.addResolveInfoForIntent(SETTING_INTENT, info);
public void getAvailabilityStatus_configIsTrue_shouldReturnAvailable() {
SettingsShadowResources.overrideResource(
R.bool.config_show_emergency_gesture_settings,
Boolean.TRUE);
SettingsShadowResources.overrideResource(
R.string.emergency_gesture_settings_package,
TEST_PKG_NAME);
mController = new EmergencyGesturePreferenceController(mContext, PREF_KEY);
assertThat(mController.mIntent).isNotNull();
assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
}
@Test
public void isAvailable_configIsTrue_shouldReturnTrue() {
SettingsShadowResources.overrideResource(
R.bool.config_show_emergency_gesture_settings,
Boolean.TRUE);
assertThat(mController.isAvailable()).isTrue();
}
@Test
public void isAvailable_configIsFalse_shouldReturnFalse() {
public void getAvailabilityStatus_configIsFalse_shouldReturnUnsupported() {
SettingsShadowResources.overrideResource(
R.bool.config_show_emergency_gesture_settings,
Boolean.FALSE);
assertThat(mController.isAvailable()).isFalse();
assertThat(mController.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE);
}
@Test
@@ -130,17 +97,7 @@ public class EmergencyGesturePreferenceControllerTest {
}
@Test
public void isSliceableCorrectKey_returnsTrue() {
final EmergencyGesturePreferenceController controller =
new EmergencyGesturePreferenceController(mContext, PREF_KEY);
assertThat(controller.isSliceable()).isTrue();
public void isSliceable_returnsFalse() {
assertThat(mController.isSliceable()).isFalse();
}
@Test
public void isSliceableIncorrectKey_returnsFalse() {
final DoubleTapPowerPreferenceController controller =
new DoubleTapPowerPreferenceController(mContext, "bad_key");
assertThat(controller.isSliceable()).isFalse();
}
}