/* 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.home import android.content.Context import androidx.core.content.ContextCompat.getColor import androidx.lifecycle.Lifecycle import androidx.lifecycle.LifecycleOwner import androidx.lifecycle.lifecycleScope import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.launch import mozilla.components.browser.menu.BrowserMenuBuilder import mozilla.components.browser.menu.BrowserMenuHighlight import mozilla.components.browser.menu.ext.getHighlight import mozilla.components.browser.menu.item.BrowserMenuDivider import mozilla.components.browser.menu.item.BrowserMenuHighlightableItem import mozilla.components.browser.menu.item.BrowserMenuImageText import mozilla.components.concept.sync.AccountObserver import mozilla.components.concept.sync.AuthType import mozilla.components.concept.sync.OAuthAccount import mozilla.components.support.ktx.android.content.getColorFromAttr import org.mozilla.fenix.R import org.mozilla.fenix.experiments.ExperimentBranch import org.mozilla.fenix.experiments.Experiments import org.mozilla.fenix.ext.components import org.mozilla.fenix.ext.settings import org.mozilla.fenix.ext.withExperiment import org.mozilla.fenix.theme.ThemeManager import org.mozilla.fenix.whatsnew.WhatsNew class HomeMenu( private val lifecycleOwner: LifecycleOwner, private val context: Context, private val onItemTapped: (Item) -> Unit = {}, private val onMenuBuilderChanged: (BrowserMenuBuilder) -> Unit = {}, private val onHighlightPresent: (BrowserMenuHighlight) -> Unit = {} ) { sealed class Item { object WhatsNew : Item() object Help : Item() object AddonsManager : Item() object Settings : Item() object SyncedTabs : Item() object History : Item() object Bookmarks : Item() object Downloads : Item() object Quit : Item() object Sync : Item() } private val primaryTextColor = ThemeManager.resolveAttribute(R.attr.primaryText, context) private val syncDisconnectedColor = ThemeManager.resolveAttribute(R.attr.syncDisconnected, context) private val syncDisconnectedBackgroundColor = context.getColorFromAttr(R.attr.syncDisconnectedBackground) private val menuCategoryTextColor = ThemeManager.resolveAttribute(R.attr.menuCategoryText, context) private val shouldUseBottomToolbar = context.settings().shouldUseBottomToolbar // 'Reconnect' and 'Quit' items aren't needed most of the time, so we'll only create the if necessary. private val reconnectToSyncItem by lazy { BrowserMenuHighlightableItem( context.getString(R.string.sync_reconnect), R.drawable.ic_sync_disconnected, iconTintColorResource = syncDisconnectedColor, textColorResource = primaryTextColor, highlight = BrowserMenuHighlight.HighPriority( backgroundTint = syncDisconnectedBackgroundColor, canPropagate = false ), isHighlighted = { true } ) { onItemTapped.invoke(Item.Sync) } } private val quitItem by lazy { BrowserMenuImageText( context.getString(R.string.delete_browsing_data_on_quit_action), R.drawable.ic_exit, primaryTextColor ) { onItemTapped.invoke(Item.Quit) } } private val coreMenuItems by lazy { val whatsNewItem = BrowserMenuHighlightableItem( context.getString(R.string.browser_menu_whats_new), R.drawable.ic_whats_new, iconTintColorResource = primaryTextColor, highlight = BrowserMenuHighlight.LowPriority( notificationTint = getColor(context, R.color.whats_new_notification_color) ), isHighlighted = { WhatsNew.shouldHighlightWhatsNew(context) } ) { onItemTapped.invoke(Item.WhatsNew) } val experiments = context.components.analytics.experiments val bookmarksIcon = experiments.withExperiment(Experiments.BOOKMARK_ICON) { when (it) { ExperimentBranch.TREATMENT -> R.drawable.ic_bookmark_list else -> R.drawable.ic_bookmark_filled } } val bookmarksItem = BrowserMenuImageText( context.getString(R.string.library_bookmarks), bookmarksIcon, primaryTextColor ) { onItemTapped.invoke(Item.Bookmarks) } // We want to validate that the Nimbus experiments library is working, from the android UI // all the way back to the data science backend. We're not testing the user's preference // or response, we're end-to-end testing the experiments platform. // So here, we're running multiple identical branches with the same treatment, and if the // user isn't targeted, then we get still get the same treatment. // The `let` block is degenerate here, but left here so as to document the form of how experiments // are implemented here. val historyIcon = experiments.withExperiment(Experiments.A_A_NIMBUS_VALIDATION) { when (it) { ExperimentBranch.A1 -> R.drawable.ic_history ExperimentBranch.A2 -> R.drawable.ic_history else -> R.drawable.ic_history } } val historyItem = BrowserMenuImageText( context.getString(R.string.library_history), historyIcon, primaryTextColor ) { onItemTapped.invoke(Item.History) } val addons = BrowserMenuImageText( context.getString(R.string.browser_menu_add_ons), R.drawable.ic_addons_extensions, primaryTextColor ) { onItemTapped.invoke(Item.AddonsManager) } val settingsItem = BrowserMenuImageText( context.getString(R.string.browser_menu_settings), R.drawable.ic_settings, primaryTextColor ) { onItemTapped.invoke(Item.Settings) } val syncedTabsItem = BrowserMenuImageText( context.getString(R.string.library_synced_tabs), R.drawable.ic_synced_tabs, primaryTextColor ) { onItemTapped.invoke(Item.SyncedTabs) } val helpItem = BrowserMenuImageText( context.getString(R.string.browser_menu_help), R.drawable.ic_help, primaryTextColor ) { onItemTapped.invoke(Item.Help) } val downloadsItem = BrowserMenuImageText( context.getString(R.string.library_downloads), R.drawable.ic_download, primaryTextColor ) { onItemTapped.invoke(Item.Downloads) } // Only query account manager if it has been initialized. // We don't want to cause its initialization just for this check. val accountAuthItem = if (context.components.backgroundServices.accountManagerAvailableQueue.isReady()) { if (context.components.backgroundServices.accountManager.accountNeedsReauth()) reconnectToSyncItem else null } else { null } val settings = context.components.settings val menuItems = listOfNotNull( if (settings.shouldDeleteBrowsingDataOnQuit) quitItem else null, settingsItem, BrowserMenuDivider(), syncedTabsItem, bookmarksItem, historyItem, downloadsItem, BrowserMenuDivider(), addons, BrowserMenuDivider(), whatsNewItem, helpItem, accountAuthItem ).also { items -> items.getHighlight()?.let { onHighlightPresent(it) } } if (shouldUseBottomToolbar) { menuItems.reversed() } else { menuItems } } init { // Report initial state. onMenuBuilderChanged(BrowserMenuBuilder(coreMenuItems)) // Observe account state changes, and update menu item builder with a new set of items. context.components.backgroundServices.accountManagerAvailableQueue.runIfReadyOrQueue { // This task isn't relevant if our parent fragment isn't around anymore. if (lifecycleOwner.lifecycle.currentState == Lifecycle.State.DESTROYED) { return@runIfReadyOrQueue } context.components.backgroundServices.accountManager.register(object : AccountObserver { override fun onAuthenticationProblems() { lifecycleOwner.lifecycleScope.launch(Dispatchers.Main) { onMenuBuilderChanged(BrowserMenuBuilder( listOf(reconnectToSyncItem) + coreMenuItems )) } } override fun onAuthenticated(account: OAuthAccount, authType: AuthType) { lifecycleOwner.lifecycleScope.launch(Dispatchers.Main) { onMenuBuilderChanged( BrowserMenuBuilder( coreMenuItems ) ) } } override fun onLoggedOut() { lifecycleOwner.lifecycleScope.launch(Dispatchers.Main) { onMenuBuilderChanged( BrowserMenuBuilder( coreMenuItems ) ) } } }, lifecycleOwner) } } }