/* * 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.search import android.content.Context import android.content.Intent import androidx.navigation.NavController import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.delay import kotlinx.coroutines.launch import mozilla.components.browser.search.SearchEngine import mozilla.components.browser.session.Session import mozilla.components.support.ktx.kotlin.isUrl import org.mozilla.fenix.BrowserDirection import org.mozilla.fenix.HomeActivity import org.mozilla.fenix.R import org.mozilla.fenix.components.metrics.Event import org.mozilla.fenix.components.metrics.Event.PerformedSearch.SearchAccessPoint.ACTION import org.mozilla.fenix.components.metrics.Event.PerformedSearch.SearchAccessPoint.NONE import org.mozilla.fenix.components.metrics.Event.PerformedSearch.SearchAccessPoint.SUGGESTION import org.mozilla.fenix.components.metrics.MetricsUtils import org.mozilla.fenix.components.searchengine.CustomSearchEngineStore import org.mozilla.fenix.crashes.CrashListActivity import org.mozilla.fenix.ext.components import org.mozilla.fenix.ext.metrics import org.mozilla.fenix.ext.navigateSafe import org.mozilla.fenix.ext.settings /** * An interface that handles the view manipulation of the Search, triggered by the Interactor */ interface SearchController { fun handleUrlCommitted(url: String) fun handleEditingCancelled() fun handleTextChanged(text: String) fun handleUrlTapped(url: String) fun handleSearchTermsTapped(searchTerms: String) fun handleSearchShortcutEngineSelected(searchEngine: SearchEngine) fun handleClickSearchEngineSettings() fun handleExistingSessionSelected(session: Session) fun handleExistingSessionSelected(tabId: String) fun handleSearchShortcutsButtonClicked() } class DefaultSearchController( private val context: Context, private val store: SearchFragmentStore, private val navController: NavController, private val viewLifecycleScope: CoroutineScope, private val clearToolbarFocus: () -> Unit ) : SearchController { override fun handleUrlCommitted(url: String) { if (url == "about:crashes") { // The list of past crashes can be accessed via "settings > about", but desktop and // fennec users may be used to navigating to "about:crashes". So we intercept this here // and open the crash list activity instead. context.startActivity(Intent(context, CrashListActivity::class.java)) return } if (url.isNotBlank()) { (context as HomeActivity).openToBrowserAndLoad( searchTermOrURL = url, newTab = store.state.session == null, from = BrowserDirection.FromSearch, engine = store.state.searchEngineSource.searchEngine ) val event = if (url.isUrl()) { Event.EnteredUrl(false) } else { val searchAccessPoint = when (store.state.searchAccessPoint) { NONE -> ACTION else -> store.state.searchAccessPoint } searchAccessPoint?.let { sap -> MetricsUtils.createSearchEvent( store.state.searchEngineSource.searchEngine, context, sap ) } } event?.let { context.metrics.track(it) } } } override fun handleEditingCancelled() { viewLifecycleScope.launch { clearToolbarFocus() // Delay a short amount so the keyboard begins animating away. This makes exit animation // much smoother instead of having two separate parts (keyboard hides THEN animation) delay(KEYBOARD_ANIMATION_DELAY) navController.popBackStack() } } override fun handleTextChanged(text: String) { // Display the search shortcuts on each entry of the search fragment (see #5308) val textMatchesCurrentUrl = store.state.session?.url ?: "" == text val textMatchesCurrentSearch = store.state.session?.searchTerms ?: "" == text store.dispatch(SearchFragmentAction.UpdateQuery(text)) store.dispatch( SearchFragmentAction.ShowSearchShortcutEnginePicker( (textMatchesCurrentUrl || textMatchesCurrentSearch || text.isEmpty()) && context.settings().shouldShowSearchShortcuts ) ) store.dispatch( SearchFragmentAction.AllowSearchSuggestionsInPrivateModePrompt( text.isNotEmpty() && (context as HomeActivity).browsingModeManager.mode.isPrivate && !context.settings().shouldShowSearchSuggestionsInPrivate && !context.settings().showSearchSuggestionsInPrivateOnboardingFinished ) ) } override fun handleUrlTapped(url: String) { (context as HomeActivity).openToBrowserAndLoad( searchTermOrURL = url, newTab = store.state.session == null, from = BrowserDirection.FromSearch ) context.metrics.track(Event.EnteredUrl(false)) } override fun handleSearchTermsTapped(searchTerms: String) { (context as HomeActivity).openToBrowserAndLoad( searchTermOrURL = searchTerms, newTab = store.state.session == null, from = BrowserDirection.FromSearch, engine = store.state.searchEngineSource.searchEngine, forceSearch = true ) val searchAccessPoint = when (store.state.searchAccessPoint) { NONE -> SUGGESTION else -> store.state.searchAccessPoint } val event = searchAccessPoint?.let { sap -> MetricsUtils.createSearchEvent( store.state.searchEngineSource.searchEngine, context, sap ) } event?.let { context.metrics.track(it) } } override fun handleSearchShortcutEngineSelected(searchEngine: SearchEngine) { store.dispatch(SearchFragmentAction.SearchShortcutEngineSelected(searchEngine)) val isCustom = CustomSearchEngineStore.isCustomSearchEngine(context, searchEngine.identifier) context.metrics.track(Event.SearchShortcutSelected(searchEngine, isCustom)) } override fun handleSearchShortcutsButtonClicked() { val isOpen = store.state.showSearchShortcuts store.dispatch(SearchFragmentAction.ShowSearchShortcutEnginePicker(!isOpen)) } override fun handleClickSearchEngineSettings() { val directions = SearchFragmentDirections.actionGlobalSearchEngineFragment() navController.navigateSafe(R.id.searchFragment, directions) } override fun handleExistingSessionSelected(session: Session) { context.components.core.sessionManager.select(session) (context as HomeActivity).openToBrowser( from = BrowserDirection.FromSearch ) } override fun handleExistingSessionSelected(tabId: String) { val session = context.components.core.sessionManager.findSessionById(tabId) if (session != null) { handleExistingSessionSelected(session) } } companion object { internal const val KEYBOARD_ANIMATION_DELAY = 5L } }