Bug 1825126 - Implement onInstallPermissionRequest in WebExtensionSupport.
Co-authored-by: William Durand <will+git@drnd.me> Co-authored-by: arturo mejia <arturomejiamarmol@gmail.com>fenix/116.0
William Durand
1 year ago
committed by
mergify[bot]
parent
b3f1997fa2
commit
bea6f0b0da
@ -0,0 +1,26 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.ext
|
||||
|
||||
import mozilla.components.feature.addons.Addon
|
||||
import mozilla.components.feature.addons.AddonManager
|
||||
import org.mozilla.fenix.BuildConfig
|
||||
import org.mozilla.fenix.Config
|
||||
|
||||
/**
|
||||
* Returns the list of all installed and recommended add-ons filters out all the
|
||||
* add-ons on [BuildConfig.MOZILLA_ONLINE_ADDON_EXCLUSIONS].
|
||||
*/
|
||||
suspend fun AddonManager.getFenixAddons(allowCache: Boolean = true): List<Addon> {
|
||||
val addons = getAddons(allowCache = allowCache)
|
||||
val excludedAddonIDs = if (Config.channel.isMozillaOnline &&
|
||||
!BuildConfig.MOZILLA_ONLINE_ADDON_EXCLUSIONS.isNullOrEmpty()
|
||||
) {
|
||||
BuildConfig.MOZILLA_ONLINE_ADDON_EXCLUSIONS.toList()
|
||||
} else {
|
||||
emptyList<String>()
|
||||
}
|
||||
return addons.filterNot { it.id in excludedAddonIDs }
|
||||
}
|
||||
@ -0,0 +1,171 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package org.mozilla.fenix.extension
|
||||
|
||||
import android.content.Context
|
||||
import android.view.Gravity
|
||||
import android.view.View
|
||||
import androidx.annotation.VisibleForTesting
|
||||
import androidx.fragment.app.FragmentManager
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.cancel
|
||||
import kotlinx.coroutines.flow.mapNotNull
|
||||
import mozilla.components.browser.state.action.WebExtensionAction
|
||||
import mozilla.components.browser.state.state.extension.WebExtensionPromptRequest
|
||||
import mozilla.components.browser.state.store.BrowserStore
|
||||
import mozilla.components.feature.addons.Addon
|
||||
import mozilla.components.feature.addons.ui.PermissionsDialogFragment
|
||||
import mozilla.components.lib.state.ext.flowScoped
|
||||
import mozilla.components.support.base.feature.LifecycleAwareFeature
|
||||
import mozilla.components.support.ktx.kotlinx.coroutines.flow.ifChanged
|
||||
import org.mozilla.fenix.R
|
||||
import org.mozilla.fenix.addons.showSnackBar
|
||||
import org.mozilla.fenix.components.FenixSnackbar
|
||||
import org.mozilla.fenix.theme.ThemeManager
|
||||
|
||||
/**
|
||||
* Feature implementation for handling [WebExtensionPromptRequest] and showing the respective UI.
|
||||
*/
|
||||
class WebExtensionPromptFeature(
|
||||
private val store: BrowserStore,
|
||||
private val provideAddons: suspend () -> List<Addon>,
|
||||
private val context: Context,
|
||||
private val view: View,
|
||||
private val fragmentManager: FragmentManager,
|
||||
) : LifecycleAwareFeature {
|
||||
|
||||
/**
|
||||
* Whether or not an add-on installation is in progress.
|
||||
*/
|
||||
private var isInstallationInProgress = false
|
||||
private var scope: CoroutineScope? = null
|
||||
|
||||
/**
|
||||
* Starts observing the selected session to listen for window requests
|
||||
* and opens / closes tabs as needed.
|
||||
*/
|
||||
override fun start() {
|
||||
scope = store.flowScoped { flow ->
|
||||
flow.mapNotNull { state ->
|
||||
state.webExtensionPromptRequest
|
||||
}.ifChanged().collect { promptRequest ->
|
||||
if (promptRequest is WebExtensionPromptRequest.Permissions && !hasExistingPermissionDialogFragment()) {
|
||||
val addon = provideAddons().find { addon ->
|
||||
addon.id == promptRequest.extension.id
|
||||
}
|
||||
|
||||
// If the add-on is not found, it is already installed because the install process can only
|
||||
// be triggered for add-ons "known" by Fenix (the add-on is either part of the official list
|
||||
// of supported extensions OR part of the user custom AMO collection).
|
||||
if (addon == null) {
|
||||
promptRequest.onConfirm(false)
|
||||
consumePromptRequest()
|
||||
showSnackBar(
|
||||
view,
|
||||
context.getString(R.string.addon_already_installed),
|
||||
FenixSnackbar.LENGTH_LONG,
|
||||
)
|
||||
} else {
|
||||
showPermissionDialog(
|
||||
addon,
|
||||
promptRequest,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
tryToReAttachButtonHandlersToPreviousDialog()
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops observing the selected session for incoming window requests.
|
||||
*/
|
||||
override fun stop() {
|
||||
scope?.cancel()
|
||||
}
|
||||
|
||||
@VisibleForTesting
|
||||
internal fun showPermissionDialog(
|
||||
addon: Addon,
|
||||
promptRequest: WebExtensionPromptRequest.Permissions,
|
||||
) {
|
||||
if (!isInstallationInProgress && !hasExistingPermissionDialogFragment()) {
|
||||
val dialog = PermissionsDialogFragment.newInstance(
|
||||
addon = addon,
|
||||
promptsStyling = PermissionsDialogFragment.PromptsStyling(
|
||||
gravity = Gravity.BOTTOM,
|
||||
shouldWidthMatchParent = true,
|
||||
positiveButtonBackgroundColor = ThemeManager.resolveAttribute(
|
||||
R.attr.accent,
|
||||
context,
|
||||
),
|
||||
positiveButtonTextColor = ThemeManager.resolveAttribute(
|
||||
R.attr.textOnColorPrimary,
|
||||
context,
|
||||
),
|
||||
positiveButtonRadius =
|
||||
(context.resources.getDimensionPixelSize(R.dimen.tab_corner_radius)).toFloat(),
|
||||
),
|
||||
onPositiveButtonClicked = {
|
||||
handleApprovedPermissions(promptRequest)
|
||||
},
|
||||
onNegativeButtonClicked = {
|
||||
handleDeniedPermissions(promptRequest)
|
||||
},
|
||||
)
|
||||
dialog.show(
|
||||
fragmentManager,
|
||||
PERMISSIONS_DIALOG_FRAGMENT_TAG,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
private fun tryToReAttachButtonHandlersToPreviousDialog() {
|
||||
findPreviousDialogFragment()?.let { dialog ->
|
||||
dialog.onPositiveButtonClicked = { addon ->
|
||||
store.state.webExtensionPromptRequest?.let { promptRequest ->
|
||||
if (addon.id == promptRequest.extension.id &&
|
||||
promptRequest is WebExtensionPromptRequest.Permissions
|
||||
) {
|
||||
handleApprovedPermissions(promptRequest)
|
||||
}
|
||||
}
|
||||
}
|
||||
dialog.onNegativeButtonClicked = {
|
||||
store.state.webExtensionPromptRequest?.let { promptRequest ->
|
||||
if (promptRequest is WebExtensionPromptRequest.Permissions) {
|
||||
handleDeniedPermissions(promptRequest)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun handleDeniedPermissions(promptRequest: WebExtensionPromptRequest.Permissions) {
|
||||
promptRequest.onConfirm(false)
|
||||
consumePromptRequest()
|
||||
}
|
||||
|
||||
private fun handleApprovedPermissions(promptRequest: WebExtensionPromptRequest.Permissions) {
|
||||
promptRequest.onConfirm(true)
|
||||
consumePromptRequest()
|
||||
}
|
||||
|
||||
private fun consumePromptRequest() {
|
||||
store.dispatch(WebExtensionAction.ConsumePromptRequestWebExtensionAction)
|
||||
}
|
||||
|
||||
private fun hasExistingPermissionDialogFragment(): Boolean {
|
||||
return findPreviousDialogFragment() != null
|
||||
}
|
||||
|
||||
private fun findPreviousDialogFragment(): PermissionsDialogFragment? {
|
||||
return fragmentManager.findFragmentByTag(PERMISSIONS_DIALOG_FRAGMENT_TAG) as? PermissionsDialogFragment
|
||||
}
|
||||
|
||||
companion object {
|
||||
private const val PERMISSIONS_DIALOG_FRAGMENT_TAG = "ADDONS_PERMISSIONS_DIALOG_FRAGMENT"
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue