Create VideoCallingRepository

Also support settings search for video calling. Fix: 233327342 Flag: EXEMPT bug fix Test: manual - on mobile settings Test: manual - search video calling Test: unit test Change-Id: Ic4a25849f77f1759fa157931d428daa9e6854ff2
2024-08-20 15:44:22 +08:00
parent a73545d878
commit f218f76221
13 changed files with 522 additions and 743 deletions
--- a/src/com/android/settings/network/ims/VtQueryImsState.java
+++ b/src/com/android/settings/network/ims/VtQueryImsState.java
@@ -18,24 +18,17 @@ package com.android.settings.network.ims;

 import android.content.Context;
 import android.telecom.TelecomManager;
-import android.telephony.AccessNetworkConstants;
 import android.telephony.SubscriptionManager;
-import android.telephony.ims.ImsException;
-import android.telephony.ims.feature.MmTelFeature;
-import android.telephony.ims.stub.ImsRegistrationImplBase;
-import android.util.Log;

 import androidx.annotation.VisibleForTesting;

 /**
 * Controller class for querying VT status
 */
-public class VtQueryImsState extends ImsQueryController {
+public class VtQueryImsState {

-    private static final String LOG_TAG = "VtQueryImsState";
-
-    private Context mContext;
-    private int mSubId;
+    private final Context mContext;
+    private final int mSubId;

    /**
     * Constructor
@@ -44,9 +37,6 @@ public class VtQueryImsState extends ImsQueryController {
     * @param subId subscription's id
     */
    public VtQueryImsState(Context context, int subId) {
-        super(MmTelFeature.MmTelCapabilities.CAPABILITY_TYPE_VIDEO,
-                ImsRegistrationImplBase.REGISTRATION_TECH_LTE,
-                AccessNetworkConstants.TRANSPORT_TYPE_WWAN);
        mContext = context;
        mSubId = subId;
    }
@@ -62,24 +52,6 @@ public class VtQueryImsState extends ImsQueryController {
        return (new ImsQueryVtUserSetting(subId)).query();
    }

-    /**
-     * Check whether Video Call can be perform or not on this subscription
-     *
-     * @return true when Video Call can be performed, otherwise false
-     */
-    public boolean isReadyToVideoCall() {
-        if (!isProvisionedOnDevice(mSubId)) {
-            return false;
-        }
-
-        try {
-            return isEnabledByPlatform(mSubId) && isServiceStateReady(mSubId);
-        } catch (InterruptedException | IllegalArgumentException | ImsException exception) {
-            Log.w(LOG_TAG, "fail to get Vt ready. subId=" + mSubId, exception);
-        }
-        return false;
-    }
-
    /**
     * Get allowance status for user to alter configuration
     *
@@ -89,8 +61,7 @@ public class VtQueryImsState extends ImsQueryController {
        if (!SubscriptionManager.isValidSubscriptionId(mSubId)) {
            return false;
        }
-        return ((!isTtyEnabled(mContext))
-                || (isTtyOnVolteEnabled(mSubId)));
+        return !isTtyEnabled(mContext) || new ImsQueryTtyOnVolteStat(mSubId).query();
    }

    @VisibleForTesting
--- a/src/com/android/settings/network/telephony/CarrierConfigRepository.kt
+++ b/src/com/android/settings/network/telephony/CarrierConfigRepository.kt
@@ -50,7 +50,7 @@ class CarrierConfigRepository(private val context: Context) {
        private val keysToRetrieve = mutableMapOf<String, KeyType>()

        override fun getBoolean(key: String): Boolean {
-            check(key.endsWith("_bool")) { "Boolean key should ends with _bool" }
+            checkBooleanKey(key)
            val value = cache[key]
            return if (value == null) {
                keysToRetrieve += key to KeyType.BOOLEAN
@@ -186,9 +186,18 @@ class CarrierConfigRepository(private val context: Context) {
            ListenerRegistered.getAndSet(false)
        }

+        private val BooleanKeysWhichNotFollowingsNamingConventions =
+            listOf(CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS)
+
+        private fun checkBooleanKey(key: String) {
+            check(key.endsWith("_bool") || key in BooleanKeysWhichNotFollowingsNamingConventions) {
+                "Boolean key should ends with _bool"
+            }
+        }
+
        @VisibleForTesting
        fun setBooleanForTest(subId: Int, key: String, value: Boolean) {
-            check(key.endsWith("_bool")) { "Boolean key should ends with _bool" }
+            checkBooleanKey(key)
            getPerSubCache(subId)[key] = BooleanConfigValue(value)
        }

--- a/src/com/android/settings/network/telephony/MobileNetworkSettingsSearchIndex.kt
+++ b/src/com/android/settings/network/telephony/MobileNetworkSettingsSearchIndex.kt
@@ -26,6 +26,7 @@ import com.android.settings.network.telephony.DataUsagePreferenceController.Comp
 import com.android.settings.network.telephony.MmsMessagePreferenceController.Companion.MmsMessageSearchItem
 import com.android.settings.network.telephony.NrAdvancedCallingPreferenceController.Companion.NrAdvancedCallingSearchItem
 import com.android.settings.network.telephony.RoamingPreferenceController.Companion.RoamingSearchItem
+import com.android.settings.network.telephony.VideoCallingPreferenceController.Companion.VideoCallingSearchItem
 import com.android.settings.network.telephony.WifiCallingPreferenceController.Companion.WifiCallingSearchItem
 import com.android.settings.spa.SpaSearchLanding.BundleValue
 import com.android.settings.spa.SpaSearchLanding.SpaSearchLandingFragment
@@ -122,6 +123,7 @@ class MobileNetworkSettingsSearchIndex(
                NrAdvancedCallingSearchItem(context),
                PreferredNetworkModeSearchItem(context),
                RoamingSearchItem(context),
+                VideoCallingSearchItem(context),
                WifiCallingSearchItem(context),
            )
    }
--- a/src/com/android/settings/network/telephony/VideoCallingPreferenceController.java
+++ b/src/com/android/settings/network/telephony/VideoCallingPreferenceController.java
@@ -1,234 +0,0 @@
-/*
- * Copyright (C) 2018 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.network.telephony;
-
-import android.content.Context;
-import android.content.pm.PackageManager;
-import android.os.PersistableBundle;
-import android.telephony.CarrierConfigManager;
-import android.telephony.SubscriptionManager;
-import android.telephony.TelephonyCallback;
-import android.telephony.TelephonyManager;
-import android.telephony.ims.ImsMmTelManager;
-import android.util.Log;
-
-import androidx.annotation.VisibleForTesting;
-import androidx.preference.Preference;
-import androidx.preference.PreferenceScreen;
-import androidx.preference.TwoStatePreference;
-
-import com.android.internal.telephony.flags.Flags;
-import com.android.settings.network.CarrierConfigCache;
-import com.android.settings.network.MobileDataEnabledListener;
-import com.android.settings.network.ims.VolteQueryImsState;
-import com.android.settings.network.ims.VtQueryImsState;
-import com.android.settingslib.core.lifecycle.LifecycleObserver;
-import com.android.settingslib.core.lifecycle.events.OnStart;
-import com.android.settingslib.core.lifecycle.events.OnStop;
-
-/**
- * Preference controller for "Video Calling"
- */
-public class VideoCallingPreferenceController extends TelephonyTogglePreferenceController implements
-        LifecycleObserver, OnStart, OnStop,
-        MobileDataEnabledListener.Client,
-        Enhanced4gBasePreferenceController.On4gLteUpdateListener {
-
-    private static final String TAG = "VideoCallingPreference";
-
-    private Preference mPreference;
-    private PhoneTelephonyCallback mTelephonyCallback;
-    @VisibleForTesting
-    Integer mCallState;
-    private MobileDataEnabledListener mDataContentObserver;
-    private CallingPreferenceCategoryController mCallingPreferenceCategoryController;
-
-    public VideoCallingPreferenceController(Context context, String key) {
-        super(context, key);
-        mDataContentObserver = new MobileDataEnabledListener(context, this);
-        mTelephonyCallback = new PhoneTelephonyCallback();
-    }
-
-    @Override
-    public int getAvailabilityStatus(int subId) {
-        return SubscriptionManager.isValidSubscriptionId(subId)
-                && isVideoCallEnabled(subId)
-                ? AVAILABLE
-                : CONDITIONALLY_UNAVAILABLE;
-    }
-
-    @Override
-    public void displayPreference(PreferenceScreen screen) {
-        super.displayPreference(screen);
-        mPreference = screen.findPreference(getPreferenceKey());
-    }
-
-    @Override
-    public void onStart() {
-        mTelephonyCallback.register(mContext, mSubId);
-        mDataContentObserver.start(mSubId);
-    }
-
-    @Override
-    public void onStop() {
-        mTelephonyCallback.unregister();
-        mDataContentObserver.stop();
-    }
-
-    @Override
-    public void updateState(Preference preference) {
-        super.updateState(preference);
-        if ((mCallState == null) || (preference == null)) {
-            Log.d(TAG, "Skip update under mCallState=" + mCallState);
-            return;
-        }
-        final TwoStatePreference switchPreference = (TwoStatePreference) preference;
-        final boolean videoCallEnabled = isVideoCallEnabled(mSubId);
-        switchPreference.setVisible(videoCallEnabled);
-        mCallingPreferenceCategoryController
-                .updateChildVisible(getPreferenceKey(), videoCallEnabled);
-        if (videoCallEnabled) {
-            final boolean videoCallEditable = queryVoLteState(mSubId).isEnabledByUser()
-                    && queryImsState(mSubId).isAllowUserControl();
-            preference.setEnabled(videoCallEditable
-                    && mCallState == TelephonyManager.CALL_STATE_IDLE);
-            switchPreference.setChecked(videoCallEditable && isChecked());
-        }
-    }
-
-    @Override
-    public boolean setChecked(boolean isChecked) {
-        if (!SubscriptionManager.isValidSubscriptionId(mSubId)) {
-            return false;
-        }
-        final ImsMmTelManager imsMmTelManager = ImsMmTelManager.createForSubscriptionId(mSubId);
-        if (imsMmTelManager == null) {
-            return false;
-        }
-        try {
-            imsMmTelManager.setVtSettingEnabled(isChecked);
-            return true;
-        } catch (IllegalArgumentException exception) {
-            Log.w(TAG, "Unable to set VT status " + isChecked + ". subId=" + mSubId,
-                    exception);
-        }
-        return false;
-    }
-
-    @Override
-    public boolean isChecked() {
-        return queryImsState(mSubId).isEnabledByUser();
-    }
-
-    @VisibleForTesting
-    protected boolean isImsSupported() {
-        return mContext.getPackageManager().hasSystemFeature(
-                PackageManager.FEATURE_TELEPHONY_IMS);
-    }
-
-    /**
-     * Init instance of VideoCallingPreferenceController.
-     */
-    public VideoCallingPreferenceController init(
-            int subId, CallingPreferenceCategoryController callingPreferenceCategoryController) {
-        mSubId = subId;
-        mCallingPreferenceCategoryController = callingPreferenceCategoryController;
-
-        return this;
-    }
-
-    @VisibleForTesting
-    boolean isVideoCallEnabled(int subId) {
-        if (!SubscriptionManager.isValidSubscriptionId(subId)) {
-            return false;
-        }
-
-        final PersistableBundle carrierConfig =
-                CarrierConfigCache.getInstance(mContext).getConfigForSubId(subId);
-        if (carrierConfig == null) {
-            return false;
-        }
-
-        if (!carrierConfig.getBoolean(
-                CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS)
-                && (!mContext.getSystemService(TelephonyManager.class)
-                    .createForSubscriptionId(subId).isDataEnabled())) {
-            return false;
-        }
-
-        return isImsSupported() && queryImsState(subId).isReadyToVideoCall();
-    }
-
-    @Override
-    public void on4gLteUpdated() {
-        updateState(mPreference);
-    }
-
-    private class PhoneTelephonyCallback extends TelephonyCallback implements
-            TelephonyCallback.CallStateListener {
-
-        private TelephonyManager mTelephonyManager;
-
-        @Override
-        public void onCallStateChanged(int state) {
-            mCallState = state;
-            updateState(mPreference);
-        }
-
-        public void register(Context context, int subId) {
-            mTelephonyManager = context.getSystemService(TelephonyManager.class);
-            if (SubscriptionManager.isValidSubscriptionId(subId)) {
-                mTelephonyManager = mTelephonyManager.createForSubscriptionId(subId);
-            }
-            // assign current call state so that it helps to show correct preference state even
-            // before first onCallStateChanged() by initial registration.
-            if (Flags.enforceTelephonyFeatureMappingForPublicApis()) {
-                try {
-                    mCallState = mTelephonyManager.getCallState(subId);
-                } catch (UnsupportedOperationException e) {
-                    // Device doesn't support FEATURE_TELEPHONY_CALLING
-                    mCallState = TelephonyManager.CALL_STATE_IDLE;
-                }
-            } else {
-                mCallState = mTelephonyManager.getCallState(subId);
-            }
-            mTelephonyManager.registerTelephonyCallback(context.getMainExecutor(), this);
-        }
-
-        public void unregister() {
-            mCallState = null;
-            mTelephonyManager.unregisterTelephonyCallback(this);
-        }
-    }
-
-    /**
-     * Implementation of MobileDataEnabledListener.Client
-     */
-    public void onMobileDataEnabledChange() {
-        updateState(mPreference);
-    }
-
-    @VisibleForTesting
-    VtQueryImsState queryImsState(int subId) {
-        return new VtQueryImsState(mContext, subId);
-    }
-
-    @VisibleForTesting
-    VolteQueryImsState queryVoLteState(int subId) {
-        return new VolteQueryImsState(mContext, subId);
-    }
-}
--- a/src/com/android/settings/network/telephony/VideoCallingPreferenceController.kt
+++ b/src/com/android/settings/network/telephony/VideoCallingPreferenceController.kt
@@ -0,0 +1,147 @@
+/*
+ * Copyright (C) 2024 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.network.telephony
+
+import android.content.Context
+import android.telephony.SubscriptionManager
+import android.telephony.TelephonyManager
+import android.telephony.ims.ImsManager
+import android.util.Log
+import androidx.annotation.VisibleForTesting
+import androidx.lifecycle.LifecycleOwner
+import androidx.preference.Preference
+import androidx.preference.PreferenceScreen
+import androidx.preference.TwoStatePreference
+import com.android.settings.R
+import com.android.settings.core.TogglePreferenceController
+import com.android.settings.network.ims.VolteQueryImsState
+import com.android.settings.network.ims.VtQueryImsState
+import com.android.settings.network.telephony.Enhanced4gBasePreferenceController.On4gLteUpdateListener
+import com.android.settings.network.telephony.MobileNetworkSettingsSearchIndex.MobileNetworkSettingsSearchItem
+import com.android.settings.network.telephony.MobileNetworkSettingsSearchIndex.MobileNetworkSettingsSearchResult
+import com.android.settingslib.spa.framework.util.collectLatestWithLifecycle
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.runBlocking
+
+/** Preference controller for "Video Calling" */
+class VideoCallingPreferenceController
+@JvmOverloads
+constructor(
+    context: Context,
+    key: String,
+    private val callStateRepository: CallStateRepository = CallStateRepository(context),
+) : TogglePreferenceController(context, key), On4gLteUpdateListener {
+
+    private var subId = SubscriptionManager.INVALID_SUBSCRIPTION_ID
+    private var preference: TwoStatePreference? = null
+    private var callingPreferenceCategoryController: CallingPreferenceCategoryController? = null
+    private val repository = VideoCallingRepository(context)
+
+    private var videoCallEditable = false
+    private var isInCall = false
+
+    /** Init instance of VideoCallingPreferenceController. */
+    fun init(
+        subId: Int,
+        callingPreferenceCategoryController: CallingPreferenceCategoryController?,
+    ): VideoCallingPreferenceController {
+        this.subId = subId
+        this.callingPreferenceCategoryController = callingPreferenceCategoryController
+
+        return this
+    }
+
+    // Availability is controlled in onViewCreated() and VideoCallingSearchItem.
+    override fun getAvailabilityStatus() = AVAILABLE
+
+    override fun displayPreference(screen: PreferenceScreen) {
+        super.displayPreference(screen)
+        preference = screen.findPreference(preferenceKey)
+    }
+
+    override fun onViewCreated(viewLifecycleOwner: LifecycleOwner) {
+        repository.isVideoCallReadyFlow(subId).collectLatestWithLifecycle(viewLifecycleOwner) {
+            isReady ->
+            preference?.isVisible = isReady
+            callingPreferenceCategoryController?.updateChildVisible(preferenceKey, isReady)
+        }
+        callStateRepository.callStateFlow(subId).collectLatestWithLifecycle(viewLifecycleOwner) {
+            callState ->
+            isInCall = callState != TelephonyManager.CALL_STATE_IDLE
+            updatePreference()
+        }
+    }
+
+    override fun updateState(preference: Preference) {
+        super.updateState(preference)
+        videoCallEditable =
+            queryVoLteState(subId).isEnabledByUser && queryImsState(subId).isAllowUserControl
+        updatePreference()
+    }
+
+    private fun updatePreference() {
+        preference?.isEnabled = videoCallEditable && !isInCall
+        preference?.isChecked = videoCallEditable && isChecked
+    }
+
+    override fun getSliceHighlightMenuRes() = NO_RES
+
+    override fun setChecked(isChecked: Boolean): Boolean {
+        if (!SubscriptionManager.isValidSubscriptionId(subId)) {
+            return false
+        }
+        val imsMmTelManager = ImsManager(mContext).getImsMmTelManager(subId)
+        try {
+            imsMmTelManager.isVtSettingEnabled = isChecked
+            return true
+        } catch (exception: IllegalArgumentException) {
+            Log.w(TAG, "[$subId] Unable to set VT status $isChecked", exception)
+        }
+        return false
+    }
+
+    override fun isChecked(): Boolean = queryImsState(subId).isEnabledByUser
+
+    override fun on4gLteUpdated() {
+        preference?.let { updateState(it) }
+    }
+
+    @VisibleForTesting fun queryImsState(subId: Int) = VtQueryImsState(mContext, subId)
+
+    @VisibleForTesting fun queryVoLteState(subId: Int) = VolteQueryImsState(mContext, subId)
+
+    companion object {
+        private const val TAG = "VideoCallingPreferenceController"
+
+        class VideoCallingSearchItem(private val context: Context) :
+            MobileNetworkSettingsSearchItem {
+            private val repository = VideoCallingRepository(context)
+
+            private fun isAvailable(subId: Int): Boolean = runBlocking {
+                repository.isVideoCallReadyFlow(subId).first()
+            }
+
+            override fun getSearchResult(subId: Int): MobileNetworkSettingsSearchResult? {
+                if (!isAvailable(subId)) return null
+                return MobileNetworkSettingsSearchResult(
+                    key = "video_calling_key",
+                    title = context.getString(R.string.video_calling_settings_title),
+                )
+            }
+        }
+    }
+}
--- a/src/com/android/settings/network/telephony/VideoCallingRepository.kt
+++ b/src/com/android/settings/network/telephony/VideoCallingRepository.kt
@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2024 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.network.telephony
+
+import android.content.Context
+import android.telephony.AccessNetworkConstants
+import android.telephony.CarrierConfigManager
+import android.telephony.SubscriptionManager
+import android.telephony.ims.feature.MmTelFeature
+import android.telephony.ims.stub.ImsRegistrationImplBase
+import com.android.settings.network.telephony.ims.ImsFeatureRepository
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flatMapLatest
+import kotlinx.coroutines.flow.flowOf
+
+@OptIn(ExperimentalCoroutinesApi::class)
+class VideoCallingRepository(
+    context: Context,
+    private val mobileDataRepository: MobileDataRepository = MobileDataRepository(context),
+    private val imsFeatureRepositoryFactory: (Int) -> ImsFeatureRepository = { subId ->
+        ImsFeatureRepository(context, subId)
+    },
+) {
+    private val carrierConfigRepository = CarrierConfigRepository(context)
+
+    fun isVideoCallReadyFlow(subId: Int): Flow<Boolean> {
+        if (!SubscriptionManager.isValidSubscriptionId(subId)) return flowOf(false)
+
+        return isPreconditionMeetFlow(subId).flatMapLatest { isPreconditionMeet ->
+            if (isPreconditionMeet) {
+                imsFeatureRepositoryFactory(subId)
+                    .isReadyFlow(
+                        capability = MmTelFeature.MmTelCapabilities.CAPABILITY_TYPE_VIDEO,
+                        tech = ImsRegistrationImplBase.REGISTRATION_TECH_LTE,
+                        transportType = AccessNetworkConstants.TRANSPORT_TYPE_WWAN,
+                    )
+            } else {
+                flowOf(false)
+            }
+        }
+    }
+
+    private fun isPreconditionMeetFlow(subId: Int): Flow<Boolean> =
+        if (carrierConfigRepository.getBoolean(
+            subId, CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS)) {
+            flowOf(true)
+        } else {
+            mobileDataRepository.isMobileDataEnabledFlow(subId)
+        }
+}