Files
app_Settings/src/com/android/settings/activityembedding/EmbeddedDeepLinkUtils.kt
Wes Okuhara cf2bcd7f1a Settings: Start search result deep link in same task
This fixes a bug where the deep link initiated from a search result
would open the results page in a separate window. The root cause was the
inclusion of the FLAG_ACTIVITY_NEW_TASK intent flag.

Bug: 381127948
Test: atest SettingsSpaUnitTests:com.android.settings.activityembedding
Test: atest CtsSettingsTestCases:SettingsMultiPaneDeepLinkTest
Test: Manually verify UI
Flag: com.android.settings.flags.settings_search_result_deep_link_in_same_task
Change-Id: I91f9e5096ad02bd87e43bae03a2b3e69256be651
2025-03-18 21:12:08 -07:00

147 lines
5.8 KiB
Kotlin

/*
* 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.activityembedding
import android.app.Activity
import android.content.ActivityNotFoundException
import android.content.Context
import android.content.Intent
import android.content.pm.UserInfo
import android.provider.Settings
import android.util.Log
import com.android.settings.SettingsActivity
import com.android.settings.SettingsActivity.EXTRA_IS_DEEPLINK_HOME_STARTED_FROM_SEARCH
import com.android.settings.Utils
import com.android.settings.flags.Flags
import com.android.settings.homepage.DeepLinkHomepageActivityInternal
import com.android.settings.homepage.SettingsHomepageActivity
import com.android.settings.password.PasswordUtils
import com.android.settingslib.spaprivileged.framework.common.userManager
object EmbeddedDeepLinkUtils {
private const val TAG = "EmbeddedDeepLinkUtils"
@JvmStatic
fun Context.tryStartMultiPaneDeepLink(
intent: Intent,
highlightMenuKey: String? = null,
): Boolean {
intent.putExtra(
SettingsActivity.EXTRA_INITIAL_CALLING_PACKAGE,
PasswordUtils.getCallingAppPackageName(activityToken),
)
val trampolineIntent: Intent
if (intent.getBooleanExtra(SettingsActivity.EXTRA_IS_FROM_SLICE, false)) {
// Get menu key for slice deep link case.
var sliceHighlightMenuKey: String? = intent.getStringExtra(
Settings.EXTRA_SETTINGS_EMBEDDED_DEEP_LINK_HIGHLIGHT_MENU_KEY
)
if (sliceHighlightMenuKey.isNullOrEmpty()) {
sliceHighlightMenuKey = highlightMenuKey
}
trampolineIntent = getTrampolineIntent(intent, sliceHighlightMenuKey)
trampolineIntent.setClass(this, DeepLinkHomepageActivityInternal::class.java)
} else {
trampolineIntent = getTrampolineIntent(intent, highlightMenuKey)
}
return startTrampolineIntent(trampolineIntent)
}
/**
* Returns the deep link trampoline intent for large screen devices.
*/
@JvmStatic
fun getTrampolineIntent(intent: Intent, highlightMenuKey: String?): Intent {
val detailIntent = Intent(intent)
// Guard against the arbitrary Intent injection.
if (detailIntent.selector != null) {
detailIntent.setSelector(null)
}
// It's a deep link intent, SettingsHomepageActivity will set SplitPairRule and start it.
return Intent(Settings.ACTION_SETTINGS_EMBED_DEEP_LINK_ACTIVITY).apply {
setPackage(Utils.SETTINGS_PACKAGE_NAME)
replaceExtras(detailIntent)
// Relay detail intent data to prevent failure of Intent#ParseUri.
// If Intent#getData() is not null, Intent#toUri will return an Uri which has the scheme
// of Intent#getData() and it may not be the scheme of an Intent.
putExtra(
SettingsHomepageActivity.EXTRA_SETTINGS_LARGE_SCREEN_DEEP_LINK_INTENT_DATA,
detailIntent.data
)
detailIntent.setData(null)
putExtra(
Settings.EXTRA_SETTINGS_EMBEDDED_DEEP_LINK_INTENT_URI,
detailIntent.toUri(Intent.URI_INTENT_SCHEME)
)
putExtra(
Settings.EXTRA_SETTINGS_EMBEDDED_DEEP_LINK_HIGHLIGHT_MENU_KEY,
highlightMenuKey
)
addFlags(Intent.FLAG_ACTIVITY_FORWARD_RESULT)
}
}
/**
* Returns the deep link trampoline intent for settings search results for large screen devices.
*/
@JvmStatic
fun getTrampolineIntentForSearchResult(
context: Context,
intent: Intent,
highlightMenuKey: String?
): Intent {
return getTrampolineIntent(intent, highlightMenuKey).apply {
if (Flags.settingsSearchResultDeepLinkInSameTask()) {
// Ensure the deep link intent does not include FLAG_ACTIVITY_NEW_TASK which
// causes the search result deep link to open in a separate window.
removeFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
putExtra(EXTRA_IS_DEEPLINK_HOME_STARTED_FROM_SEARCH, true)
} else {
addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS)
}
setClass(context, DeepLinkHomepageActivityInternal::class.java)
}
}
/**
* Returns whether the user is a sub profile.
*/
@JvmStatic
fun isSubProfile(userInfo: UserInfo): Boolean =
userInfo.isManagedProfile || userInfo.isPrivateProfile
private fun Context.startTrampolineIntent(trampolineIntent: Intent): Boolean = try {
val userInfo = userManager.getUserInfo(user.identifier)
if (isSubProfile(userInfo)) {
trampolineIntent.setClass(this, DeepLinkHomepageActivityInternal::class.java)
.putExtra(SettingsActivity.EXTRA_USER_HANDLE, user)
startActivityAsUser(
trampolineIntent,
userManager.getProfileParent(userInfo.id).userHandle
)
} else {
startActivity(trampolineIntent)
}
true
} catch (e: ActivityNotFoundException) {
Log.e(TAG, "Deep link homepage is not available to show 2-pane UI")
false
}
}