You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
423 lines
16 KiB
Kotlin
423 lines
16 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.library.bookmarks
|
|
|
|
import android.content.DialogInterface
|
|
import android.os.Bundle
|
|
import android.text.SpannableString
|
|
import android.view.LayoutInflater
|
|
import android.view.Menu
|
|
import android.view.MenuInflater
|
|
import android.view.MenuItem
|
|
import android.view.View
|
|
import android.view.ViewGroup
|
|
import androidx.appcompat.app.AlertDialog
|
|
import androidx.core.content.getSystemService
|
|
import androidx.core.view.isVisible
|
|
import androidx.fragment.app.activityViewModels
|
|
import androidx.lifecycle.lifecycleScope
|
|
import androidx.navigation.NavDirections
|
|
import androidx.navigation.fragment.findNavController
|
|
import androidx.navigation.fragment.navArgs
|
|
import kotlinx.android.synthetic.main.component_bookmark.view.*
|
|
import kotlinx.android.synthetic.main.fragment_bookmark.view.*
|
|
import kotlinx.coroutines.CoroutineScope
|
|
import kotlinx.coroutines.Dispatchers.IO
|
|
import kotlinx.coroutines.Dispatchers.Main
|
|
import kotlinx.coroutines.ExperimentalCoroutinesApi
|
|
import kotlinx.coroutines.async
|
|
import kotlinx.coroutines.awaitAll
|
|
import kotlinx.coroutines.isActive
|
|
import kotlinx.coroutines.launch
|
|
import kotlinx.coroutines.withContext
|
|
import mozilla.appservices.places.BookmarkRoot
|
|
import mozilla.components.concept.engine.prompt.ShareData
|
|
import mozilla.components.concept.storage.BookmarkNode
|
|
import mozilla.components.concept.storage.BookmarkNodeType
|
|
import mozilla.components.lib.state.ext.consumeFrom
|
|
import mozilla.components.support.base.feature.UserInteractionHandler
|
|
import org.mozilla.fenix.HomeActivity
|
|
import org.mozilla.fenix.NavHostActivity
|
|
import org.mozilla.fenix.R
|
|
import org.mozilla.fenix.components.FenixSnackbar
|
|
import org.mozilla.fenix.components.StoreProvider
|
|
import org.mozilla.fenix.components.metrics.Event
|
|
import org.mozilla.fenix.ext.bookmarkStorage
|
|
import org.mozilla.fenix.ext.components
|
|
import org.mozilla.fenix.ext.minus
|
|
import org.mozilla.fenix.ext.nav
|
|
import org.mozilla.fenix.ext.requireComponents
|
|
import org.mozilla.fenix.ext.setTextColor
|
|
import org.mozilla.fenix.ext.toShortUrl
|
|
import org.mozilla.fenix.library.LibraryPageFragment
|
|
import org.mozilla.fenix.utils.allowUndo
|
|
|
|
/**
|
|
* The screen that displays the user's bookmark list in their Library.
|
|
*/
|
|
@Suppress("TooManyFunctions", "LargeClass")
|
|
class BookmarkFragment : LibraryPageFragment<BookmarkNode>(), UserInteractionHandler {
|
|
|
|
private lateinit var bookmarkStore: BookmarkFragmentStore
|
|
private lateinit var bookmarkView: BookmarkView
|
|
private var _bookmarkInteractor: BookmarkFragmentInteractor? = null
|
|
private val bookmarkInteractor: BookmarkFragmentInteractor
|
|
get() = _bookmarkInteractor!!
|
|
|
|
private val sharedViewModel: BookmarksSharedViewModel by activityViewModels()
|
|
private val desktopFolders by lazy { DesktopFolders(requireContext(), showMobileRoot = false) }
|
|
|
|
private var pendingBookmarkDeletionJob: (suspend () -> Unit)? = null
|
|
private var pendingBookmarksToDelete: MutableSet<BookmarkNode> = mutableSetOf()
|
|
|
|
private val metrics
|
|
get() = context?.components?.analytics?.metrics
|
|
|
|
override val selectedItems get() = bookmarkStore.state.mode.selectedItems
|
|
|
|
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
|
|
val view = inflater.inflate(R.layout.fragment_bookmark, container, false)
|
|
|
|
bookmarkStore = StoreProvider.get(this) {
|
|
BookmarkFragmentStore(BookmarkFragmentState(null))
|
|
}
|
|
|
|
_bookmarkInteractor = BookmarkFragmentInteractor(
|
|
bookmarksController = DefaultBookmarkController(
|
|
activity = requireActivity() as HomeActivity,
|
|
navController = findNavController(),
|
|
clipboardManager = requireContext().getSystemService(),
|
|
scope = viewLifecycleOwner.lifecycleScope,
|
|
store = bookmarkStore,
|
|
sharedViewModel = sharedViewModel,
|
|
tabsUseCases = activity?.components?.useCases?.tabsUseCases,
|
|
loadBookmarkNode = ::loadBookmarkNode,
|
|
showSnackbar = ::showSnackBarWithText,
|
|
deleteBookmarkNodes = ::deleteMulti,
|
|
deleteBookmarkFolder = ::showRemoveFolderDialog,
|
|
invokePendingDeletion = ::invokePendingDeletion,
|
|
showTabTray = ::showTabTray
|
|
),
|
|
metrics = metrics!!
|
|
)
|
|
|
|
bookmarkView = BookmarkView(view.bookmarkLayout, bookmarkInteractor, findNavController())
|
|
bookmarkView.view.bookmark_folders_sign_in.visibility = View.GONE
|
|
|
|
viewLifecycleOwner.lifecycle.addObserver(
|
|
BookmarkDeselectNavigationListener(
|
|
findNavController(),
|
|
sharedViewModel,
|
|
bookmarkInteractor
|
|
)
|
|
)
|
|
|
|
return view
|
|
}
|
|
|
|
private fun showSnackBarWithText(text: String) {
|
|
view?.let {
|
|
FenixSnackbar.make(
|
|
view = it,
|
|
duration = FenixSnackbar.LENGTH_LONG,
|
|
isDisplayedWithBrowserToolbar = false
|
|
).setText(text).show()
|
|
}
|
|
}
|
|
|
|
@ExperimentalCoroutinesApi
|
|
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
|
|
super.onViewCreated(view, savedInstanceState)
|
|
val accountManager = requireComponents.backgroundServices.accountManager
|
|
consumeFrom(bookmarkStore) {
|
|
bookmarkView.update(it)
|
|
|
|
// Only display the sign-in prompt if we're inside of the virtual "Desktop Bookmarks" node.
|
|
// Don't want to pester user too much with it, and if there are lots of bookmarks present,
|
|
// it'll just get visually lost. Inside of the "Desktop Bookmarks" node, it'll nicely stand-out,
|
|
// since there are always only three other items in there. It's also the right place contextually.
|
|
bookmarkView.view.bookmark_folders_sign_in.isVisible =
|
|
it.tree?.guid == BookmarkRoot.Root.id && accountManager.authenticatedAccount() == null
|
|
}
|
|
}
|
|
|
|
override fun onCreate(savedInstanceState: Bundle?) {
|
|
super.onCreate(savedInstanceState)
|
|
setHasOptionsMenu(true)
|
|
}
|
|
|
|
override fun onResume() {
|
|
super.onResume()
|
|
|
|
(activity as NavHostActivity).getSupportActionBarAndInflateIfNecessary().show()
|
|
|
|
// Reload bookmarks when returning to this fragment in case they have been edited
|
|
val args by navArgs<BookmarkFragmentArgs>()
|
|
val currentGuid = bookmarkStore.state.tree?.guid
|
|
?: if (args.currentRoot.isNotEmpty()) {
|
|
args.currentRoot
|
|
} else {
|
|
BookmarkRoot.Mobile.id
|
|
}
|
|
loadInitialBookmarkFolder(currentGuid)
|
|
}
|
|
|
|
private fun loadInitialBookmarkFolder(currentGuid: String) {
|
|
viewLifecycleOwner.lifecycleScope.launch(Main) {
|
|
val currentRoot = loadBookmarkNode(currentGuid)
|
|
|
|
if (isActive && currentRoot != null) {
|
|
bookmarkInteractor.onBookmarksChanged(currentRoot)
|
|
}
|
|
}
|
|
}
|
|
|
|
override fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater) {
|
|
when (val mode = bookmarkStore.state.mode) {
|
|
is BookmarkFragmentState.Mode.Normal -> {
|
|
if (mode.showMenu) {
|
|
inflater.inflate(R.menu.bookmarks_menu, menu)
|
|
}
|
|
}
|
|
is BookmarkFragmentState.Mode.Selecting -> {
|
|
if (mode.selectedItems.any { it.type != BookmarkNodeType.ITEM }) {
|
|
inflater.inflate(R.menu.bookmarks_select_multi_not_item, menu)
|
|
} else {
|
|
inflater.inflate(R.menu.bookmarks_select_multi, menu)
|
|
|
|
menu.findItem(R.id.delete_bookmarks_multi_select).title =
|
|
SpannableString(getString(R.string.bookmark_menu_delete_button)).apply {
|
|
setTextColor(requireContext(), R.attr.destructive)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
override fun onOptionsItemSelected(item: MenuItem): Boolean {
|
|
return when (item.itemId) {
|
|
R.id.close_bookmarks -> {
|
|
invokePendingDeletion()
|
|
close()
|
|
true
|
|
}
|
|
R.id.add_bookmark_folder -> {
|
|
navigateToBookmarkFragment(
|
|
BookmarkFragmentDirections
|
|
.actionBookmarkFragmentToBookmarkAddFolderFragment()
|
|
)
|
|
true
|
|
}
|
|
R.id.open_bookmarks_in_new_tabs_multi_select -> {
|
|
openItemsInNewTab { node -> node.url }
|
|
|
|
showTabTray()
|
|
metrics?.track(Event.OpenedBookmarksInNewTabs)
|
|
true
|
|
}
|
|
R.id.open_bookmarks_in_private_tabs_multi_select -> {
|
|
openItemsInNewTab(private = true) { node -> node.url }
|
|
|
|
showTabTray()
|
|
metrics?.track(Event.OpenedBookmarksInPrivateTabs)
|
|
true
|
|
}
|
|
R.id.share_bookmark_multi_select -> {
|
|
val shareTabs = bookmarkStore.state.mode.selectedItems.map {
|
|
ShareData(url = it.url, title = it.title)
|
|
}
|
|
navigateToBookmarkFragment(
|
|
BookmarkFragmentDirections.actionGlobalShareFragment(
|
|
data = shareTabs.toTypedArray()
|
|
)
|
|
)
|
|
true
|
|
}
|
|
R.id.delete_bookmarks_multi_select -> {
|
|
deleteMulti(bookmarkStore.state.mode.selectedItems)
|
|
true
|
|
}
|
|
else -> super.onOptionsItemSelected(item)
|
|
}
|
|
}
|
|
|
|
private fun showTabTray() {
|
|
invokePendingDeletion()
|
|
navigateToBookmarkFragment(BookmarkFragmentDirections.actionGlobalTabsTrayFragment())
|
|
}
|
|
|
|
private fun navigateToBookmarkFragment(directions: NavDirections) {
|
|
invokePendingDeletion()
|
|
findNavController().nav(
|
|
R.id.bookmarkFragment,
|
|
directions
|
|
)
|
|
}
|
|
|
|
override fun onBackPressed(): Boolean {
|
|
invokePendingDeletion()
|
|
return bookmarkView.onBackPressed()
|
|
}
|
|
|
|
private suspend fun loadBookmarkNode(guid: String): BookmarkNode? = withContext(IO) {
|
|
requireContext().bookmarkStorage
|
|
.getTree(guid, false)
|
|
?.let { desktopFolders.withOptionalDesktopFolders(it) }
|
|
}
|
|
|
|
private suspend fun refreshBookmarks() {
|
|
// The bookmark tree in our 'state' can be null - meaning, no bookmark tree has been selected.
|
|
// If that's the case, we don't know what node to refresh, and so we bail out.
|
|
// See https://github.com/mozilla-mobile/fenix/issues/4671
|
|
val currentGuid = bookmarkStore.state.tree?.guid ?: return
|
|
loadBookmarkNode(currentGuid)
|
|
?.let { node ->
|
|
val rootNode = node - pendingBookmarksToDelete
|
|
bookmarkInteractor.onBookmarksChanged(rootNode)
|
|
}
|
|
}
|
|
|
|
override fun onPause() {
|
|
invokePendingDeletion()
|
|
super.onPause()
|
|
}
|
|
|
|
private suspend fun deleteSelectedBookmarks(selected: Set<BookmarkNode>) {
|
|
CoroutineScope(IO).launch {
|
|
val tempStorage = context?.bookmarkStorage
|
|
selected.map {
|
|
async { tempStorage?.deleteNode(it.guid) }
|
|
}.awaitAll()
|
|
}
|
|
}
|
|
|
|
private fun deleteMulti(selected: Set<BookmarkNode>, eventType: Event = Event.RemoveBookmarks) {
|
|
selected.forEach { if (it.type == BookmarkNodeType.FOLDER) {
|
|
showRemoveFolderDialog(selected)
|
|
return
|
|
} }
|
|
updatePendingBookmarksToDelete(selected)
|
|
|
|
pendingBookmarkDeletionJob = getDeleteOperation(eventType)
|
|
|
|
val message = when (eventType) {
|
|
is Event.RemoveBookmarks -> {
|
|
getRemoveBookmarksSnackBarMessage(selected, containsFolders = false)
|
|
}
|
|
is Event.RemoveBookmarkFolder,
|
|
is Event.RemoveBookmark -> {
|
|
val bookmarkNode = selected.first()
|
|
getString(
|
|
R.string.bookmark_deletion_snackbar_message,
|
|
bookmarkNode.url?.toShortUrl(requireContext().components.publicSuffixList) ?: bookmarkNode.title
|
|
)
|
|
}
|
|
else -> throw IllegalStateException("Illegal event type in onDeleteSome")
|
|
}
|
|
|
|
viewLifecycleOwner.lifecycleScope.allowUndo(
|
|
requireView(), message,
|
|
getString(R.string.bookmark_undo_deletion), {
|
|
undoPendingDeletion(selected)
|
|
}, operation = getDeleteOperation(eventType)
|
|
)
|
|
}
|
|
|
|
private fun getRemoveBookmarksSnackBarMessage(
|
|
selected: Set<BookmarkNode>,
|
|
containsFolders: Boolean
|
|
): String {
|
|
return if (selected.size > 1) {
|
|
return if (containsFolders) {
|
|
getString(R.string.bookmark_deletion_multiple_snackbar_message_3)
|
|
} else {
|
|
getString(R.string.bookmark_deletion_multiple_snackbar_message_2)
|
|
}
|
|
} else {
|
|
val bookmarkNode = selected.first()
|
|
getString(
|
|
R.string.bookmark_deletion_snackbar_message,
|
|
bookmarkNode.url?.toShortUrl(requireContext().components.publicSuffixList)
|
|
?: bookmarkNode.title
|
|
)
|
|
}
|
|
}
|
|
|
|
private fun getDialogConfirmationMessage(selected: Set<BookmarkNode>): String {
|
|
return if (selected.size > 1) {
|
|
getString(R.string.bookmark_delete_multiple_folders_confirmation_dialog, getString(R.string.app_name))
|
|
} else {
|
|
getString(R.string.bookmark_delete_folder_confirmation_dialog)
|
|
}
|
|
}
|
|
|
|
override fun onDestroyView() {
|
|
super.onDestroyView()
|
|
_bookmarkInteractor = null
|
|
}
|
|
|
|
private fun showRemoveFolderDialog(selected: Set<BookmarkNode>) {
|
|
activity?.let { activity ->
|
|
AlertDialog.Builder(activity).apply {
|
|
val dialogConfirmationMessage = getDialogConfirmationMessage(selected)
|
|
setMessage(dialogConfirmationMessage)
|
|
setNegativeButton(R.string.delete_browsing_data_prompt_cancel) { dialog: DialogInterface, _ ->
|
|
dialog.cancel()
|
|
}
|
|
setPositiveButton(R.string.delete_browsing_data_prompt_allow) { dialog: DialogInterface, _ ->
|
|
updatePendingBookmarksToDelete(selected)
|
|
pendingBookmarkDeletionJob = getDeleteOperation(Event.RemoveBookmarkFolder)
|
|
dialog.dismiss()
|
|
val snackbarMessage = getRemoveBookmarksSnackBarMessage(selected, containsFolders = true)
|
|
// Use fragment's lifecycle; the view may be gone by the time dialog is interacted with.
|
|
lifecycleScope.allowUndo(
|
|
requireView(),
|
|
snackbarMessage,
|
|
getString(R.string.bookmark_undo_deletion),
|
|
{
|
|
undoPendingDeletion(selected)
|
|
},
|
|
operation = getDeleteOperation(Event.RemoveBookmarkFolder)
|
|
)
|
|
}
|
|
create()
|
|
}
|
|
.show()
|
|
}
|
|
}
|
|
|
|
private fun updatePendingBookmarksToDelete(selected: Set<BookmarkNode>) {
|
|
pendingBookmarksToDelete.addAll(selected)
|
|
val bookmarkTree = sharedViewModel.selectedFolder!! - pendingBookmarksToDelete
|
|
bookmarkInteractor.onBookmarksChanged(bookmarkTree)
|
|
}
|
|
|
|
private suspend fun undoPendingDeletion(selected: Set<BookmarkNode>) {
|
|
pendingBookmarksToDelete.removeAll(selected)
|
|
pendingBookmarkDeletionJob = null
|
|
refreshBookmarks()
|
|
}
|
|
|
|
private fun getDeleteOperation(event: Event): (suspend () -> Unit) {
|
|
return {
|
|
deleteSelectedBookmarks(pendingBookmarksToDelete)
|
|
pendingBookmarkDeletionJob = null
|
|
// Since this runs in a coroutine, we can't depend upon the fragment still being attached
|
|
metrics?.track(event)
|
|
refreshBookmarks()
|
|
}
|
|
}
|
|
|
|
private fun invokePendingDeletion() {
|
|
pendingBookmarkDeletionJob?.let {
|
|
viewLifecycleOwner.lifecycleScope.launch {
|
|
it.invoke()
|
|
}.invokeOnCompletion {
|
|
pendingBookmarkDeletionJob = null
|
|
}
|
|
}
|
|
}
|
|
}
|