354 lines
14 KiB
Kotlin
354 lines
14 KiB
Kotlin
/* 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.components.toolbar
|
|
|
|
import android.content.Context
|
|
import androidx.annotation.ColorRes
|
|
import androidx.core.content.ContextCompat.getColor
|
|
import androidx.lifecycle.LifecycleOwner
|
|
import androidx.lifecycle.lifecycleScope
|
|
import kotlinx.coroutines.Job
|
|
import kotlinx.coroutines.launch
|
|
import mozilla.components.browser.menu.BrowserMenuHighlight
|
|
import mozilla.components.browser.menu.WebExtensionBrowserMenuBuilder
|
|
import mozilla.components.browser.menu.item.BrowserMenuDivider
|
|
import mozilla.components.browser.menu.item.BrowserMenuHighlightableItem
|
|
import mozilla.components.browser.menu.item.BrowserMenuHighlightableSwitch
|
|
import mozilla.components.browser.menu.item.BrowserMenuImageSwitch
|
|
import mozilla.components.browser.menu.item.BrowserMenuImageText
|
|
import mozilla.components.browser.menu.item.BrowserMenuItemToolbar
|
|
import mozilla.components.browser.session.Session
|
|
import mozilla.components.browser.session.SessionManager
|
|
import mozilla.components.concept.storage.BookmarksStorage
|
|
import org.mozilla.fenix.R
|
|
import org.mozilla.fenix.browser.browsingmode.BrowsingMode
|
|
import org.mozilla.fenix.ext.components
|
|
import org.mozilla.fenix.theme.ThemeManager
|
|
import org.mozilla.fenix.utils.Settings
|
|
|
|
/**
|
|
* Builds the toolbar object used with the 3-dot menu in the browser fragment.
|
|
* @param sessionManager Reference to the session manager that contains all tabs.
|
|
* @param hasAccountProblem If true, there was a problem signing into the Firefox account.
|
|
* @param shouldReverseItems If true, reverse the menu items.
|
|
* @param onItemTapped Called when a menu item is tapped.
|
|
* @param lifecycleOwner View lifecycle owner used to determine when to cancel UI jobs.
|
|
* @param bookmarksStorage Used to check if a page is bookmarked.
|
|
*/
|
|
@Suppress("LargeClass")
|
|
class DefaultToolbarMenu(
|
|
private val context: Context,
|
|
private val sessionManager: SessionManager,
|
|
hasAccountProblem: Boolean = false,
|
|
shouldReverseItems: Boolean,
|
|
private val onItemTapped: (ToolbarMenu.Item) -> Unit = {},
|
|
private val lifecycleOwner: LifecycleOwner,
|
|
private val bookmarksStorage: BookmarksStorage
|
|
) : ToolbarMenu {
|
|
|
|
private var currentUrlIsBookmarked = false
|
|
private var isBookmarkedJob: Job? = null
|
|
|
|
/** Gets the current browser session */
|
|
private val session: Session? get() = sessionManager.selectedSession
|
|
|
|
override val menuBuilder by lazy {
|
|
WebExtensionBrowserMenuBuilder(
|
|
menuItems,
|
|
endOfMenuAlwaysVisible = true,
|
|
store = context.components.core.store,
|
|
appendExtensionActionAtStart = !shouldReverseItems
|
|
)
|
|
}
|
|
|
|
override val menuToolbar by lazy {
|
|
val forward = BrowserMenuItemToolbar.TwoStateButton(
|
|
primaryImageResource = mozilla.components.ui.icons.R.drawable.mozac_ic_forward,
|
|
primaryContentDescription = context.getString(R.string.browser_menu_forward),
|
|
primaryImageTintResource = primaryTextColor(),
|
|
isInPrimaryState = {
|
|
session?.canGoForward ?: true
|
|
},
|
|
secondaryImageTintResource = ThemeManager.resolveAttribute(R.attr.disabled, context),
|
|
disableInSecondaryState = true
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Forward)
|
|
}
|
|
|
|
val refresh = BrowserMenuItemToolbar.TwoStateButton(
|
|
primaryImageResource = mozilla.components.ui.icons.R.drawable.mozac_ic_refresh,
|
|
primaryContentDescription = context.getString(R.string.browser_menu_refresh),
|
|
primaryImageTintResource = primaryTextColor(),
|
|
isInPrimaryState = {
|
|
session?.loading == false
|
|
},
|
|
secondaryImageResource = mozilla.components.ui.icons.R.drawable.mozac_ic_stop,
|
|
secondaryContentDescription = context.getString(R.string.browser_menu_stop),
|
|
secondaryImageTintResource = primaryTextColor(),
|
|
disableInSecondaryState = false
|
|
) {
|
|
if (session?.loading == true) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Stop)
|
|
} else {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Reload)
|
|
}
|
|
}
|
|
|
|
val share = BrowserMenuItemToolbar.Button(
|
|
imageResource = R.drawable.mozac_ic_share,
|
|
contentDescription = context.getString(R.string.browser_menu_share),
|
|
iconTintColorResource = primaryTextColor(),
|
|
listener = {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Share)
|
|
}
|
|
)
|
|
|
|
registerForIsBookmarkedUpdates()
|
|
val bookmark = BrowserMenuItemToolbar.TwoStateButton(
|
|
primaryImageResource = R.drawable.ic_bookmark_filled,
|
|
primaryContentDescription = context.getString(R.string.browser_menu_edit_bookmark),
|
|
primaryImageTintResource = primaryTextColor(),
|
|
// TwoStateButton.isInPrimaryState must be synchronous, and checking bookmark state is
|
|
// relatively slow. The best we can do here is periodically compute and cache a new "is
|
|
// bookmarked" state, and use that whenever the menu has been opened.
|
|
isInPrimaryState = { currentUrlIsBookmarked },
|
|
secondaryImageResource = R.drawable.ic_bookmark_outline,
|
|
secondaryContentDescription = context.getString(R.string.browser_menu_bookmark),
|
|
secondaryImageTintResource = primaryTextColor(),
|
|
disableInSecondaryState = false
|
|
) {
|
|
if (!currentUrlIsBookmarked) currentUrlIsBookmarked = true
|
|
onItemTapped.invoke(ToolbarMenu.Item.Bookmark)
|
|
}
|
|
|
|
BrowserMenuItemToolbar(listOf(forward, bookmark, share, refresh))
|
|
}
|
|
|
|
private val menuItems by lazy {
|
|
// Predicates that are called once, during screen init
|
|
val shouldShowSaveToCollection =
|
|
context.components.browsingModeManager.mode == BrowsingMode.Normal
|
|
val shouldDeleteDataOnQuit = Settings.getInstance(context)
|
|
.shouldDeleteBrowsingDataOnQuit
|
|
|
|
// Predicates that need to be repeatedly called as the session changes
|
|
fun shouldShowAddToHomescreen(): Boolean =
|
|
session != null && context.components.useCases.webAppUseCases.isPinningSupported()
|
|
fun shouldShowReaderMode(): Boolean = session?.readerable ?: false
|
|
fun shouldShowOpenInApp(): Boolean = session?.let { session ->
|
|
val appLink = context.components.useCases.appLinksUseCases.appLinkRedirect
|
|
appLink(session.url).hasExternalApp()
|
|
} ?: false
|
|
fun shouldShowReaderAppearance(): Boolean = session?.readerMode ?: false
|
|
|
|
val menuItems = listOfNotNull(
|
|
help,
|
|
settings,
|
|
library,
|
|
desktopMode,
|
|
addToTopSites,
|
|
addToHomescreen.apply { visible = ::shouldShowAddToHomescreen },
|
|
addons,
|
|
findInPage,
|
|
privateTab,
|
|
newTab,
|
|
reportIssue,
|
|
if (shouldShowSaveToCollection) saveToCollection else null,
|
|
if (shouldDeleteDataOnQuit) deleteDataOnQuit else null,
|
|
readerMode.apply { visible = ::shouldShowReaderMode },
|
|
readerAppearance.apply { visible = ::shouldShowReaderAppearance },
|
|
openInApp.apply { visible = ::shouldShowOpenInApp },
|
|
BrowserMenuDivider(),
|
|
menuToolbar
|
|
)
|
|
|
|
if (shouldReverseItems) { menuItems.reversed() } else { menuItems }
|
|
}
|
|
|
|
private val addons = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_addon_manager),
|
|
imageResource = R.drawable.mozac_ic_extensions,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.AddonsManager)
|
|
}
|
|
|
|
private val help = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_help),
|
|
imageResource = R.drawable.ic_help,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Help)
|
|
}
|
|
|
|
private val settings = BrowserMenuHighlightableItem(
|
|
label = context.getString(R.string.browser_menu_settings),
|
|
startImageResource = R.drawable.ic_settings,
|
|
iconTintColorResource = if (hasAccountProblem)
|
|
R.color.sync_error_text_color else
|
|
primaryTextColor(),
|
|
textColorResource = if (hasAccountProblem)
|
|
R.color.sync_error_text_color else
|
|
primaryTextColor(),
|
|
highlight = BrowserMenuHighlight.HighPriority(
|
|
endImageResource = R.drawable.ic_alert,
|
|
backgroundTint = R.color.sync_error_background_color
|
|
),
|
|
isHighlighted = { hasAccountProblem }
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Settings)
|
|
}
|
|
|
|
private val library = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_your_library),
|
|
imageResource = R.drawable.ic_library,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Library)
|
|
}
|
|
|
|
private val desktopMode = BrowserMenuImageSwitch(
|
|
imageResource = R.drawable.ic_desktop,
|
|
label = context.getString(R.string.browser_menu_desktop_site),
|
|
initialState = {
|
|
session?.desktopMode ?: false
|
|
}
|
|
) { checked ->
|
|
onItemTapped.invoke(ToolbarMenu.Item.RequestDesktop(checked))
|
|
}
|
|
|
|
private val addToTopSites = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_add_to_top_sites),
|
|
imageResource = R.drawable.ic_home,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.AddToTopSites)
|
|
}
|
|
|
|
private val addToHomescreen = BrowserMenuHighlightableItem(
|
|
label = context.getString(R.string.browser_menu_add_to_homescreen),
|
|
startImageResource = R.drawable.ic_add_to_homescreen,
|
|
iconTintColorResource = primaryTextColor(),
|
|
highlight = BrowserMenuHighlight.LowPriority(
|
|
label = context.getString(R.string.browser_menu_install_on_homescreen),
|
|
notificationTint = getColor(context, R.color.whats_new_notification_color)
|
|
),
|
|
isHighlighted = {
|
|
val webAppUseCases = context.components.useCases.webAppUseCases
|
|
webAppUseCases.isPinningSupported() && webAppUseCases.isInstallable()
|
|
}
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.AddToHomeScreen)
|
|
}
|
|
|
|
private val findInPage = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_find_in_page),
|
|
imageResource = R.drawable.mozac_ic_search,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.FindInPage)
|
|
}
|
|
|
|
private val privateTab = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_private_tab),
|
|
imageResource = R.drawable.ic_private_browsing,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.NewPrivateTab)
|
|
}
|
|
|
|
private val newTab = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_new_tab),
|
|
imageResource = R.drawable.ic_new,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.NewTab)
|
|
}
|
|
|
|
private val reportIssue = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_report_issue),
|
|
imageResource = R.drawable.ic_report_issues,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.ReportIssue)
|
|
}
|
|
|
|
private val saveToCollection = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_save_to_collection),
|
|
imageResource = R.drawable.ic_tab_collection,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.SaveToCollection)
|
|
}
|
|
|
|
private val deleteDataOnQuit = BrowserMenuImageText(
|
|
label = context.getString(R.string.delete_browsing_data_on_quit_action),
|
|
imageResource = R.drawable.ic_exit,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.Quit)
|
|
}
|
|
|
|
private val readerMode = BrowserMenuHighlightableSwitch(
|
|
label = context.getString(R.string.browser_menu_read),
|
|
startImageResource = R.drawable.ic_readermode,
|
|
initialState = {
|
|
session?.readerMode ?: false
|
|
},
|
|
highlight = BrowserMenuHighlight.LowPriority(
|
|
label = context.getString(R.string.browser_menu_read),
|
|
notificationTint = getColor(context, R.color.whats_new_notification_color)
|
|
),
|
|
isHighlighted = { true }
|
|
) { checked ->
|
|
onItemTapped.invoke(ToolbarMenu.Item.ReaderMode(checked))
|
|
}
|
|
|
|
private val readerAppearance = BrowserMenuImageText(
|
|
label = context.getString(R.string.browser_menu_read_appearance),
|
|
imageResource = R.drawable.ic_readermode_appearance,
|
|
iconTintColorResource = primaryTextColor()
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.ReaderModeAppearance)
|
|
}
|
|
|
|
private val openInApp = BrowserMenuHighlightableItem(
|
|
label = context.getString(R.string.browser_menu_open_app_link),
|
|
startImageResource = R.drawable.ic_app_links,
|
|
iconTintColorResource = primaryTextColor(),
|
|
highlight = BrowserMenuHighlight.LowPriority(
|
|
label = context.getString(R.string.browser_menu_open_app_link),
|
|
notificationTint = getColor(context, R.color.whats_new_notification_color)
|
|
),
|
|
isHighlighted = { true }
|
|
) {
|
|
onItemTapped.invoke(ToolbarMenu.Item.OpenInApp)
|
|
}
|
|
|
|
@ColorRes
|
|
private fun primaryTextColor() = ThemeManager.resolveAttribute(R.attr.primaryText, context)
|
|
|
|
private fun registerForIsBookmarkedUpdates() {
|
|
val observer = object : Session.Observer {
|
|
override fun onUrlChanged(session: Session, url: String) {
|
|
currentUrlIsBookmarked = false
|
|
updateCurrentUrlIsBookmarked(url)
|
|
}
|
|
}
|
|
|
|
session?.url?.let { updateCurrentUrlIsBookmarked(it) }
|
|
session?.register(observer, lifecycleOwner)
|
|
}
|
|
|
|
private fun updateCurrentUrlIsBookmarked(newUrl: String) {
|
|
isBookmarkedJob?.cancel()
|
|
isBookmarkedJob = lifecycleOwner.lifecycleScope.launch {
|
|
currentUrlIsBookmarked = bookmarksStorage
|
|
.getBookmarksWithUrl(newUrl)
|
|
.any { it.url == newUrl }
|
|
}
|
|
}
|
|
}
|