[Git][tpo/applications/tor-browser][tor-browser-128.8.0esr-14.5-1] 5 commits: fixup! [android] Implement Android-native Connection Assist UI
Dan Ballard pushed to branch tor-browser-128.8.0esr-14.5-1 at The Tor Project / Applications / Tor Browser
Commits: 52589797 by clairehurst at 2025-03-19T18:33:18-06:00 fixup! [android] Implement Android-native Connection Assist UI
Bug 41188: Wire up stages to UI
- - - - - f0a7fed9 by clairehurst at 2025-03-19T18:33:18-06:00 fixup! TB 42247: Android helpers for the TorProvider
Bug 41188: Wire up stages to UI
- - - - - 9fe16689 by clairehurst at 2025-03-19T18:33:19-06:00 add to fixup! TB 42247: Android helpers for the TorProvider
- - - - - c1ec88a7 by clairehurst at 2025-03-19T18:33:19-06:00 add to fixup! [android] Implement Android-native Connection Assist UI
- - - - - 293696bb by Dan Ballard at 2025-03-19T17:58:54-07:00 fixup! fixup! TB 42247: Android helpers for the TorProvider
- - - - -
12 changed files:
- mobile/android/fenix/app/src/main/java/org/mozilla/fenix/HomeActivity.kt - mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/ConnectAssistUiState.kt - mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/QuickstartViewModel.kt - mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/TorBootstrapProgressViewModel.kt - mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/TorConnectionAssistFragment.kt - mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/TorConnectionAssistViewModel.kt - mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/UrlQuickLoadViewModel.kt - mobile/android/fenix/app/src/main/res/layout/fragment_tor_connection_assist.xml - mobile/android/fenix/app/src/main/res/values/colors.xml - mobile/android/fenix/app/src/main/res/values/torbrowser_strings.xml - mobile/android/geckoview/src/main/java/org/mozilla/geckoview/TorAndroidIntegration.java - toolkit/modules/TorAndroidIntegration.sys.mjs
Changes:
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/HomeActivity.kt ===================================== @@ -1111,6 +1111,7 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity, TorAn .setAllCapsForActionButton(false) .setAction(getString(R.string.connection_assist_connect_to_tor_before_opening_links_confirmation)) { urlQuickLoadViewModel.urlToLoadAfterConnecting.value = searchTermOrURL + urlQuickLoadViewModel.maybeBeginBootstrap() if (navHost.navController.previousBackStackEntry?.destination?.id == R.id.torConnectionAssistFragment) { supportFragmentManager.popBackStack() } else {
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/ConnectAssistUiState.kt ===================================== @@ -2,14 +2,12 @@ package org.mozilla.fenix.tor
import androidx.annotation.ColorRes import androidx.annotation.DrawableRes -import androidx.annotation.IntRange import androidx.annotation.StringRes import org.mozilla.fenix.R
enum class ConnectAssistUiState( val progressBarVisible: Boolean, - @IntRange(0, 100) var progress: Int = 0, - @ColorRes val progressTintColorResource: Int? = null, + @ColorRes val progressBackgroundTintColorResource: Int = R.color.progress_background_tint, val backButtonVisible: Boolean, val settingsButtonVisible: Boolean, val torConnectImageVisible: Boolean, @@ -23,18 +21,19 @@ enum class ConnectAssistUiState( @StringRes val internetErrorDescription2: Int? = null, @StringRes val titleDescriptionTextStringResource: Int? = R.string.preferences_tor_network_settings_explanation, val quickstartSwitchVisible: Boolean, - val unblockTheInternetInCountryDescriptionVisible: Boolean, val countryDropDownVisible: Boolean, + @StringRes val countryDropDownDefaultItem: Int = R.string.connection_assist_automatic_country_detection, val torBootstrapButton1Visible: Boolean, @StringRes val torBootstrapButton1TextStringResource: Int = R.string.tor_bootstrap_connect, - val torBootstrapButton1ShouldShowTryingABridge: Boolean = false, + val torBootstrapButton1ShouldTryABridge: Boolean = false, + val torBootstrapButton1ShouldOpenSettings: Boolean = false, val torBootstrapButton2Visible: Boolean, @StringRes val torBootstrapButton2TextStringResource: Int? = R.string.connection_assist_configure_connection_button, val torBootstrapButton2ShouldOpenSettings: Boolean = true, val wordmarkLogoVisible: Boolean = false, val torBootstrapButton2ShouldRestartApp: Boolean = false, ) { - Splash( + Loading( progressBarVisible = false, backButtonVisible = false, settingsButtonVisible = false, @@ -42,15 +41,13 @@ enum class ConnectAssistUiState( titleLargeTextViewVisible = false, titleDescriptionVisible = false, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = false, torBootstrapButton2Visible = false, wordmarkLogoVisible = true, ), - Configuring( + Start( progressBarVisible = false, - progress = 0, backButtonVisible = false, settingsButtonVisible = true, torConnectImageVisible = true, @@ -60,16 +57,14 @@ enum class ConnectAssistUiState( titleDescriptionVisible = true, titleDescriptionTextStringResource = R.string.preferences_tor_network_settings_explanation, quickstartSwitchVisible = true, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = true, torBootstrapButton2Visible = true, torBootstrapButton2TextStringResource = R.string.connection_assist_configure_connection_button, torBootstrapButton2ShouldOpenSettings = true, ), - Connecting( + Bootstrapping( progressBarVisible = true, - progress = 0, backButtonVisible = false, settingsButtonVisible = true, torConnectImageVisible = true, @@ -79,17 +74,15 @@ enum class ConnectAssistUiState( titleDescriptionVisible = true, titleDescriptionTextStringResource = R.string.preferences_tor_network_settings_explanation, quickstartSwitchVisible = true, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = false, torBootstrapButton2Visible = true, torBootstrapButton2TextStringResource = R.string.btn_cancel, torBootstrapButton2ShouldOpenSettings = false, ), - InternetError( + Offline( progressBarVisible = true, - progress = 100, - progressTintColorResource = R.color.warning_yellow, + progressBackgroundTintColorResource = R.color.warning_yellow, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -101,7 +94,6 @@ enum class ConnectAssistUiState( internetErrorDescription = R.string.connection_assist_internet_error_description, titleDescriptionTextStringResource = null, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = true, torBootstrapButton1TextStringResource = R.string.connection_assist_internet_error_try_again, @@ -111,8 +103,6 @@ enum class ConnectAssistUiState( ), TryingAgain( progressBarVisible = true, - progress = 0, - progressTintColorResource = null, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -124,17 +114,15 @@ enum class ConnectAssistUiState( internetErrorDescription = R.string.connection_assist_internet_error_description, titleDescriptionTextStringResource = null, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = false, torBootstrapButton2Visible = true, torBootstrapButton2TextStringResource = R.string.btn_cancel, torBootstrapButton2ShouldOpenSettings = false, ), - ConnectionAssist( + ChooseRegion( progressBarVisible = true, - progress = 100, - progressTintColorResource = R.color.warning_yellow, + progressBackgroundTintColorResource = R.color.warning_yellow, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -146,19 +134,16 @@ enum class ConnectAssistUiState( internetErrorDescription = R.string.connection_assist_try_a_bridge_description, titleDescriptionTextStringResource = null, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = true, countryDropDownVisible = true, torBootstrapButton1Visible = true, torBootstrapButton1TextStringResource = R.string.connection_assist_try_a_bridge_button, - torBootstrapButton1ShouldShowTryingABridge = true, + torBootstrapButton1ShouldTryABridge = true, torBootstrapButton2Visible = false, torBootstrapButton2TextStringResource = null, torBootstrapButton2ShouldOpenSettings = true, ), TryingABridge( progressBarVisible = true, - progress = 0, - progressTintColorResource = null, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -167,20 +152,18 @@ enum class ConnectAssistUiState( titleLargeTextViewTextStringResource = R.string.connection_assist_trying_a_bridge_title, titleDescriptionVisible = true, learnMoreStringResource = R.string.connection_assist_internet_error_learn_more, - internetErrorDescription = R.string.connection_assist_try_a_bridge_description, + internetErrorDescription = ChooseRegion.internetErrorDescription, titleDescriptionTextStringResource = null, quickstartSwitchVisible = true, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = false, torBootstrapButton2Visible = true, torBootstrapButton2TextStringResource = R.string.btn_cancel, torBootstrapButton2ShouldOpenSettings = false, ), - LocationError( + RegionNotFound( progressBarVisible = true, - progress = 100, - progressTintColorResource = R.color.warning_yellow, + progressBackgroundTintColorResource = R.color.warning_yellow, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -194,19 +177,39 @@ enum class ConnectAssistUiState( internetErrorDescription2 = R.string.connection_assist_select_country_try_again, titleDescriptionTextStringResource = null, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = true, countryDropDownVisible = true, + countryDropDownDefaultItem = R.string.connection_assist_select_country_or_region, torBootstrapButton1Visible = true, torBootstrapButton1TextStringResource = R.string.connection_assist_try_a_bridge_button, - torBootstrapButton1ShouldShowTryingABridge = true, + torBootstrapButton1ShouldTryABridge = true, torBootstrapButton2Visible = false, torBootstrapButton2TextStringResource = null, torBootstrapButton2ShouldOpenSettings = true, ), - LocationCheck( + TryingABridgeRegionNotFound( + progressBarVisible = true, + backButtonVisible = true, + settingsButtonVisible = true, + torConnectImageVisible = true, + torConnectImageResource = R.drawable.connect, + titleLargeTextViewVisible = true, + titleLargeTextViewTextStringResource = R.string.connection_assist_trying_a_bridge_title, + titleDescriptionVisible = true, + learnMoreStringResource = R.string.connection_assist_internet_error_learn_more, + internetErrorDescription = RegionNotFound.internetErrorDescription, + internetErrorDescription1 = RegionNotFound.internetErrorDescription1, + internetErrorDescription2 = RegionNotFound.internetErrorDescription2, + titleDescriptionTextStringResource = null, + quickstartSwitchVisible = true, + countryDropDownVisible = false, + torBootstrapButton1Visible = false, + torBootstrapButton2Visible = true, + torBootstrapButton2TextStringResource = R.string.btn_cancel, + torBootstrapButton2ShouldOpenSettings = false, + ), + ConfirmRegion( progressBarVisible = true, - progress = 100, - progressTintColorResource = R.color.warning_yellow, + progressBackgroundTintColorResource = R.color.warning_yellow, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -220,18 +223,38 @@ enum class ConnectAssistUiState( internetErrorDescription2 = R.string.connection_assist_select_country_try_again, titleDescriptionTextStringResource = null, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = true, countryDropDownVisible = true, + countryDropDownDefaultItem = R.string.connection_assist_select_country_or_region, torBootstrapButton1Visible = true, torBootstrapButton1TextStringResource = R.string.connection_assist_try_a_bridge_button, - torBootstrapButton1ShouldShowTryingABridge = true, + torBootstrapButton1ShouldTryABridge = true, torBootstrapButton2Visible = false, torBootstrapButton2TextStringResource = null, torBootstrapButton2ShouldOpenSettings = true, ), + TryingABridgeConfirmRegion( + progressBarVisible = true, + backButtonVisible = true, + settingsButtonVisible = true, + torConnectImageVisible = true, + torConnectImageResource = R.drawable.connect, + titleLargeTextViewVisible = true, + titleLargeTextViewTextStringResource = R.string.connection_assist_trying_a_bridge_title, + titleDescriptionVisible = true, + learnMoreStringResource = R.string.connection_assist_internet_error_learn_more, + internetErrorDescription = ConfirmRegion.internetErrorDescription, + internetErrorDescription1 = ConfirmRegion.internetErrorDescription1, + internetErrorDescription2 = ConfirmRegion.internetErrorDescription2, + titleDescriptionTextStringResource = null, + quickstartSwitchVisible = true, + countryDropDownVisible = false, + torBootstrapButton1Visible = false, + torBootstrapButton2Visible = true, + torBootstrapButton2TextStringResource = R.string.btn_cancel, + torBootstrapButton2ShouldOpenSettings = false, + ), LastTry( progressBarVisible = true, - progress = 0, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -245,7 +268,6 @@ enum class ConnectAssistUiState( internetErrorDescription2 = R.string.connection_assist_select_country_try_again, titleDescriptionTextStringResource = null, quickstartSwitchVisible = true, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = false, torBootstrapButton2Visible = true, @@ -254,8 +276,7 @@ enum class ConnectAssistUiState( ), FinalError( progressBarVisible = true, - progress = 100, - progressTintColorResource = R.color.warning_yellow, + progressBackgroundTintColorResource = R.color.warning_yellow, backButtonVisible = true, settingsButtonVisible = true, torConnectImageVisible = true, @@ -268,10 +289,10 @@ enum class ConnectAssistUiState( internetErrorDescription1 = R.string.connection_assist_final_error_troubleshoot_connection_link, titleDescriptionTextStringResource = null, quickstartSwitchVisible = false, - unblockTheInternetInCountryDescriptionVisible = false, countryDropDownVisible = false, torBootstrapButton1Visible = true, torBootstrapButton1TextStringResource = R.string.connection_assist_configure_connection_button, + torBootstrapButton1ShouldOpenSettings = true, torBootstrapButton2Visible = true, torBootstrapButton2TextStringResource = R.string.mozac_lib_crash_dialog_button_restart, torBootstrapButton2ShouldOpenSettings = false,
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/QuickstartViewModel.kt ===================================== @@ -12,19 +12,19 @@ class QuickstartViewModel( ) : AndroidViewModel(application) {
private val components = getApplication<Application>().components - private val torIntegrationAndroid = + private val torAndroidIntegration = (components.core.engine as GeckoEngine).getTorIntegrationController()
/** * NOTE: Whilst the initial value for _quickstart is fetched from - * TorIntegrationAndroid.quickstartGet (which is surfaced from TorConnect.quickstart), and we + * TorAndroidIntegration.quickstartGet (which is surfaced from TorConnect.quickstart), and we * pass on any changes in value up to TorConnect.quickstart (via quickstartSet()), we do not * listen for any changes to the TorConnect.quickstart value via "QuickstartChange" because we * do not expect anything outside of TorConnectViewModel to change its value, so we expect its * value to remain in sync with our local value. */ init { - torIntegrationAndroid.quickstartGet { + torAndroidIntegration.quickstartGet { _quickstart.value = it components.settings.quickStart = it } @@ -36,7 +36,7 @@ class QuickstartViewModel( }
fun quickstartSet(value: Boolean) { - torIntegrationAndroid.quickstartSet(value) + torAndroidIntegration.quickstartSet(value) _quickstart.value = value components.settings.quickStart = value }
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/TorBootstrapProgressViewModel.kt ===================================== @@ -11,7 +11,7 @@ class TorBootstrapProgressViewModel( application: Application, ) : AndroidViewModel(application), BootstrapStateChangeListener {
- private val torIntegrationAndroid = + private val torAndroidIntegration = application.components.core.geckoRuntime.torIntegrationController
val progress: MutableLiveData<Int> by lazy { @@ -19,11 +19,11 @@ class TorBootstrapProgressViewModel( }
init { - torIntegrationAndroid.registerBootstrapStateChangeListener(this) + torAndroidIntegration.registerBootstrapStateChangeListener(this) }
override fun onCleared() { - torIntegrationAndroid.unregisterBootstrapStateChangeListener(this) + torAndroidIntegration.unregisterBootstrapStateChangeListener(this) super.onCleared() }
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/TorConnectionAssistFragment.kt ===================================== @@ -4,6 +4,8 @@
package org.mozilla.fenix.tor
+import android.content.BroadcastReceiver +import android.content.Context import android.content.Intent import android.graphics.Color import android.os.Build @@ -17,7 +19,10 @@ import android.util.Log import android.view.LayoutInflater import android.view.View import android.view.ViewGroup +import android.widget.AdapterView +import android.widget.ArrayAdapter import androidx.appcompat.content.res.AppCompatResources +import androidx.core.view.isEmpty import androidx.fragment.app.Fragment import androidx.fragment.app.activityViewModels import androidx.fragment.app.viewModels @@ -38,7 +43,6 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { private val progressViewModel: TorBootstrapProgressViewModel by viewModels() private val quickstartViewModel: QuickstartViewModel by activityViewModels() private val torConnectionAssistViewModel : TorConnectionAssistViewModel by viewModels() - private val urlQuickLoadViewModel : UrlQuickLoadViewModel by activityViewModels()
private var _binding: FragmentTorConnectionAssistBinding? = null private val binding get() = _binding!! @@ -52,9 +56,18 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { inflater, container, false, )
+ object : BroadcastReceiver() { + override fun onReceive(context: Context, intent: Intent) { + if (intent.action === Intent.ACTION_LOCALE_CHANGED) { + Log.v("LocaleReceiver", "received ACTION_LOCALE_CHANGED") + torConnectionAssistViewModel.fetchCountryNamesGet() + } + } + } + viewLifecycleOwner.lifecycleScope.launch { repeatOnLifecycle(Lifecycle.State.STARTED) { - torConnectionAssistViewModel.collectLastKnownStatus() + torConnectionAssistViewModel.collectTorConnectStage() } }
@@ -65,12 +78,6 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { } }
- urlQuickLoadViewModel.urlToLoadAfterConnecting.observe(viewLifecycleOwner) { url -> - if (!url.isNullOrBlank()) { - torConnectionAssistViewModel.handleConnect() - } - } - return binding.root }
@@ -129,14 +136,10 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { private fun setProgressBar(screen: ConnectAssistUiState) { binding.torBootstrapProgressBar.visibility = if (screen.progressBarVisible) View.VISIBLE else View.GONE - binding.torBootstrapProgressBar.progress = screen.progress - binding.torBootstrapProgressBar.progressTintList = - screen.progressTintColorResource?.let { - AppCompatResources.getColorStateList( - requireContext(), - it, - ) - } + binding.torBootstrapProgressBar.progressBackgroundTintList = AppCompatResources.getColorStateList( + requireContext(), + screen.progressBackgroundTintColorResource, + ) }
private fun setSettingsButton(screen: ConnectAssistUiState) { @@ -201,17 +204,126 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { }
private fun setCountryDropDown(screen: ConnectAssistUiState) { - binding.unblockTheInternetInCountryDescription.visibility = - if (screen.unblockTheInternetInCountryDescriptionVisible) View.VISIBLE else View.GONE - binding.countryDropDown.visibility = if (screen.countryDropDownVisible) View.VISIBLE else View.GONE + if (screen.countryDropDownVisible) { + val spinnerAdapter: ArrayAdapter<String> = initializeSpinner() + if (binding.countryDropDown.isEmpty()) { + populateCountryDropDown(spinnerAdapter) + setOnItemSelectedListener() + } + + setFirstItemInCountryDropDown(spinnerAdapter, getString(screen.countryDropDownDefaultItem)) + + if (screen == ConnectAssistUiState.ChooseRegion || screen == ConnectAssistUiState.ConfirmRegion || screen == ConnectAssistUiState.RegionNotFound) { + torConnectionAssistViewModel.selectDefaultRegion() + binding.countryDropDown.setSelection(spinnerAdapter.getPosition(torConnectionAssistViewModel.selectedCountryCode.value)) + } + + binding.unblockTheInternetInCountryDescription.visibility = View.VISIBLE + binding.countryDropDown.visibility = View.VISIBLE + } else { + binding.unblockTheInternetInCountryDescription.visibility = View.GONE + binding.countryDropDown.visibility = View.GONE + } + } + + private fun setFirstItemInCountryDropDown( + spinnerAdapter: ArrayAdapter<String>, + item: String, + ) { + if (!spinnerAdapter.isEmpty) { + spinnerAdapter.remove(spinnerAdapter.getItem(0)) + } + spinnerAdapter.insert(item, 0) + } + + private fun initializeSpinner(): ArrayAdapter<String> { + val spinnerAdapter: ArrayAdapter<String> = + ArrayAdapter<String>( + requireContext(), + android.R.layout.simple_spinner_item, + android.R.id.text1, + ) + spinnerAdapter.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item) + binding.countryDropDown.adapter = spinnerAdapter + return spinnerAdapter + } + + private fun populateCountryDropDown(spinnerAdapter: ArrayAdapter<String>) { + torConnectionAssistViewModel.fetchCountryNamesGet() + viewLifecycleOwner.lifecycleScope.launch { + repeatOnLifecycle(Lifecycle.State.STARTED) { + torConnectionAssistViewModel.countryCodeNameMap.collect { + Log.d(TAG, "countryCodeNameMap: $it") + if (it != null) { + spinnerAdapter.clear() + spinnerAdapter.add(getString(torConnectionAssistViewModel.torConnectScreen.value.countryDropDownDefaultItem)) + spinnerAdapter.addAll(it.values) + } + } + } + } + } + + private fun setOnItemSelectedListener() { + binding.countryDropDown.onItemSelectedListener = + object : AdapterView.OnItemSelectedListener { + override fun onItemSelected( + parent: AdapterView<*>?, + view: View?, + position: Int, + id: Long, + ) { + torConnectionAssistViewModel.setCountryCodeToSelectedItem(position) + updateButton1(torConnectionAssistViewModel.torConnectScreen.value) + } + + override fun onNothingSelected(parent: AdapterView<*>?) {} + } }
private fun setButton1(screen: ConnectAssistUiState) { - binding.torBootstrapButton1.visibility = - if (screen.torBootstrapButton1Visible) View.VISIBLE else View.GONE - binding.torBootstrapButton1.text = getString(screen.torBootstrapButton1TextStringResource) - binding.torBootstrapButton1.setOnClickListener { - torConnectionAssistViewModel.handleConnect() + binding.torBootstrapButton1.apply { + visibility = + if (screen.torBootstrapButton1Visible) View.VISIBLE else View.GONE + text = getString(screen.torBootstrapButton1TextStringResource) + setOnClickListener { + if (screen.torBootstrapButton1ShouldOpenSettings) { + openTorConnectionSettings() + } else { + torConnectionAssistViewModel.handleConnect() + } + } + updateButton1(screen) + } + } + + private fun updateButton1(screen: ConnectAssistUiState) { + binding.torBootstrapButton1.apply { + if (!torConnectionAssistViewModel.button1ShouldBeDisabled(screen)) { + isEnabled = true + backgroundTintList = AppCompatResources.getColorStateList( + requireContext(), + R.color.connect_button_purple, + ) + setTextColor( + AppCompatResources.getColorStateList( + requireContext(), + R.color.photonLightGrey05, + ), + ) + } else { + isEnabled = false + backgroundTintList = AppCompatResources.getColorStateList( + requireContext(), + R.color.disabled_connect_button_purple, + ) + setTextColor( + AppCompatResources.getColorStateList( + requireContext(), + R.color.disabled_text_gray_purple, + ), + ) + } } }
@@ -235,13 +347,12 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { } } binding.torBootstrapButton2.setOnClickListener { - torConnectionAssistViewModel.cancelTorBootstrap() if (screen.torBootstrapButton2ShouldOpenSettings) { openTorConnectionSettings() } else if (screen.torBootstrapButton2ShouldRestartApp) { restartApplication() } else { - showScreen(ConnectAssistUiState.Configuring) + torConnectionAssistViewModel.cancelTorBootstrap() } } } @@ -297,11 +408,7 @@ class TorConnectionAssistFragment : Fragment(), UserInteractionHandler { }
private fun openTorConnectionSettings() { - findNavController().navigate( - TorConnectionAssistFragmentDirections.actionTorConnectionAssistFragmentToSettingsFragment( - requireContext().getString(R.string.pref_key_connection) - ), - ) + openSettings(requireContext().getString(R.string.pref_key_connection)) }
private fun restartApplication() {
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/TorConnectionAssistViewModel.kt ===================================== @@ -11,186 +11,148 @@ import androidx.lifecycle.MutableLiveData import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.flow.StateFlow import org.mozilla.fenix.HomeActivity +import org.mozilla.fenix.R import org.mozilla.fenix.ext.components +import org.mozilla.gecko.util.GeckoBundle +import org.mozilla.geckoview.TorAndroidIntegration.BootstrapStateChangeListener +import org.mozilla.geckoview.TorConnectStage +import org.mozilla.geckoview.TorConnectStageName
class TorConnectionAssistViewModel( application: Application, -) : AndroidViewModel(application) { +) : AndroidViewModel(application), BootstrapStateChangeListener {
private val TAG = "torConnectionAssistVM" - private val torIntegrationAndroid = + private val torAndroidIntegration = application.components.core.geckoRuntime.torIntegrationController - private val _torController: TorControllerGV = application.components.torController
- private val _torConnectScreen = MutableStateFlow(ConnectAssistUiState.Splash) - internal val torConnectScreen: StateFlow<ConnectAssistUiState> = _torConnectScreen - - val shouldOpenHome: MutableLiveData<Boolean> by lazy { - MutableLiveData(false) + init { + torAndroidIntegration.registerBootstrapStateChangeListener(this) }
- fun handleConnect() { - if (_torConnectScreen.value.torBootstrapButton1ShouldShowTryingABridge) { - tryABridge() - } else { - if (_torController.lastKnownStatus.value.isOff()) { - torIntegrationAndroid.beginBootstrap() + fun fetchCountryNamesGet() { + torAndroidIntegration.countryNamesGet { countryNames : GeckoBundle? -> + if (countryNames != null) { + val codes: Array<String> = countryNames.keys() + val regions = mutableMapOf<String, String>() + for (code in codes) { + regions[code] = countryNames.getString(code) + } + countryCodeNameMap.value = regions } } }
- fun cancelTorBootstrap() { - torIntegrationAndroid.cancelBootstrap() - _torController.setTorStopped() - } - - suspend fun collectLastKnownStatus() { - _torController.lastKnownStatus.collect { - when (it) { - TorConnectState.Initial -> _torConnectScreen.value = ConnectAssistUiState.Splash - TorConnectState.Configuring -> handleConfiguring() - TorConnectState.AutoBootstrapping -> handleBootstrap() - TorConnectState.Bootstrapping -> handleBootstrap() - TorConnectState.Bootstrapped -> shouldOpenHome.value = true - TorConnectState.Disabled -> shouldOpenHome.value = true - TorConnectState.Error -> handleError() - } - } + override fun onCleared() { + torAndroidIntegration.unregisterBootstrapStateChangeListener(this) + super.onCleared() }
- private fun handleConfiguring() { - if (_torController.lastKnownError == null) { - _torConnectScreen.value = ConnectAssistUiState.Configuring - } else { - handleError() - } + private val torConnectStage: MutableStateFlow<TorConnectStage?> by lazy { + MutableStateFlow(torAndroidIntegration.lastKnowStage.value) }
- private fun handleBootstrap() { - when (_torConnectScreen.value) { - ConnectAssistUiState.InternetError -> { - _torConnectScreen.value = ConnectAssistUiState.TryingAgain - } - - ConnectAssistUiState.TryingAgain -> { - /** stay here */ - } - - ConnectAssistUiState.ConnectionAssist -> { - _torConnectScreen.value = ConnectAssistUiState.TryingABridge - } - - ConnectAssistUiState.LocationError -> { - _torConnectScreen.value = ConnectAssistUiState.TryingABridge - } + private val _torConnectScreen = MutableStateFlow(ConnectAssistUiState.Loading) + internal val torConnectScreen: StateFlow<ConnectAssistUiState> = _torConnectScreen
- ConnectAssistUiState.TryingABridge -> { - /** stay here */ - } + val countryCodeNameMap: MutableStateFlow<Map<String, String>?> by lazy { + MutableStateFlow(null) + }
- ConnectAssistUiState.LocationCheck -> { - _torConnectScreen.value = ConnectAssistUiState.LastTry - } + val selectedCountryCode: MutableStateFlow<String> by lazy { + MutableStateFlow("automatic") + }
- ConnectAssistUiState.LastTry -> { - /** stay here */ - } + fun selectDefaultRegion() { + selectedCountryCode.value = torConnectStage.value?.defaultRegion ?: "automatic" + }
- else -> _torConnectScreen.value = - ConnectAssistUiState.Connecting - } + fun setCountryCodeToSelectedItem(position: Int) { + selectedCountryCode.value = + countryCodeNameMap.value?.keys?.toList() + ?.getOrNull(position - 1) ?: "automatic" + // position - 1 since we have the default/first value of automatic + Log.d(TAG, "selectedCountryCode = ${selectedCountryCode.value}") }
- private fun handleError() { - _torController.lastKnownError?.apply { - Log.d( - TAG, - "TorError(message = $message, details = $details, phase = $phase, reason = $reason", - ) - // TODO better error handling - when (reason) { -// "noroute" -> handleNoRoute() TODO re-add when working better - else -> handleUnknownError() - } - } + val shouldOpenHome: MutableLiveData<Boolean> by lazy { + MutableLiveData(false) }
- private fun handleNoRoute() { - Log.d(TAG, "handleNoRoute(), _torConnectScreen.value = ${_torConnectScreen.value}") - when (_torConnectScreen.value) { - ConnectAssistUiState.Connecting -> _torConnectScreen.value = ConnectAssistUiState.ConnectionAssist - ConnectAssistUiState.ConnectionAssist -> {/** no op, likely a duplicate error */} - ConnectAssistUiState.TryingABridge -> _torConnectScreen.value = ConnectAssistUiState.LocationCheck - ConnectAssistUiState.LocationCheck -> {/** no op, likely a duplicate error */} - ConnectAssistUiState.LastTry -> _torConnectScreen.value = ConnectAssistUiState.FinalError - ConnectAssistUiState.FinalError -> {/** no op, likely a duplicate error */} - else -> _torConnectScreen.value = ConnectAssistUiState.InternetError + fun handleConnect() { + val screen = _torConnectScreen.value + if (screen.torBootstrapButton1ShouldTryABridge && !button1ShouldBeDisabled(screen)) { + Log.d(TAG, "beginAutoBootstrap with countryCode: ${selectedCountryCode.value}") + torAndroidIntegration.beginAutoBootstrap(selectedCountryCode.value) + } else { + torAndroidIntegration.beginBootstrap() } }
- private fun handleUnknownError() { - // TODO should we have a dedicated screen for unknown errors? - _torConnectScreen.value = ConnectAssistUiState.InternetError + fun cancelTorBootstrap() { + torAndroidIntegration.cancelBootstrap() }
- private fun tryABridge() { - if (!locationFound()) { - _torConnectScreen.value = ConnectAssistUiState.LocationError - return - } - if (!_torController.bridgesEnabled) { - _torController.bridgesEnabled = true - _torController.bridgeTransport = - TorBridgeTransportConfig.BUILTIN_SNOWFLAKE // TODO select based on country + suspend fun collectTorConnectStage() { + torConnectStage.collect { + Log.d(TAG, "torConnectStageName: ${it?.name}") + when (it?.name) { + TorConnectStageName.Disabled -> shouldOpenHome.value = true // TODO use TorConnect.enabled instead to determine this + TorConnectStageName.Loading -> _torConnectScreen.value = ConnectAssistUiState.Loading + TorConnectStageName.Start -> _torConnectScreen.value = ConnectAssistUiState.Start + TorConnectStageName.Bootstrapping -> _torConnectScreen.value = handleBootstrapTrigger(it.bootstrapTrigger) + TorConnectStageName.Offline -> _torConnectScreen.value = ConnectAssistUiState.Offline + TorConnectStageName.ChooseRegion -> _torConnectScreen.value = ConnectAssistUiState.ChooseRegion + TorConnectStageName.RegionNotFound -> _torConnectScreen.value = ConnectAssistUiState.RegionNotFound + TorConnectStageName.ConfirmRegion -> _torConnectScreen.value = ConnectAssistUiState.ConfirmRegion + TorConnectStageName.FinalError -> _torConnectScreen.value = ConnectAssistUiState.FinalError + TorConnectStageName.Bootstrapped -> shouldOpenHome.value = true + null -> {} + } } - torIntegrationAndroid.beginBootstrap() }
- private fun locationFound(): Boolean { - // TODO try to find location - return true + private fun handleBootstrapTrigger(bootstrapTrigger: TorConnectStageName) : ConnectAssistUiState { + Log.d(TAG, "bootstrapTrigger: $bootstrapTrigger") + return when (bootstrapTrigger) { + TorConnectStageName.Start -> ConnectAssistUiState.Bootstrapping + TorConnectStageName.Offline -> ConnectAssistUiState.TryingAgain + TorConnectStageName.ChooseRegion -> ConnectAssistUiState.TryingABridge + TorConnectStageName.RegionNotFound -> ConnectAssistUiState.TryingABridgeRegionNotFound + TorConnectStageName.ConfirmRegion -> ConnectAssistUiState.TryingABridgeConfirmRegion + else -> { + Log.e(TAG, "Unexpected bootstrapTrigger of $bootstrapTrigger") + ConnectAssistUiState.TryingAgain + } + } }
fun handleBackButtonPressed(homeActivity: HomeActivity) { when (torConnectScreen.value) { - ConnectAssistUiState.Splash -> homeActivity.shutDown() - ConnectAssistUiState.Configuring -> homeActivity.shutDown() - ConnectAssistUiState.Connecting -> cancelTorBootstrap() - ConnectAssistUiState.InternetError -> { - _torController.lastKnownError = null - _torConnectScreen.value = ConnectAssistUiState.Configuring - } - - ConnectAssistUiState.TryingAgain -> { - cancelTorBootstrap() - } + ConnectAssistUiState.Loading -> homeActivity.shutDown() + ConnectAssistUiState.Start -> homeActivity.shutDown() + else -> torAndroidIntegration.startAgain() + } + }
- ConnectAssistUiState.ConnectionAssist -> { - _torController.lastKnownError = null - _torConnectScreen.value = ConnectAssistUiState.Configuring - } + override fun onBootstrapStateChange(state: String?) {}
- ConnectAssistUiState.TryingABridge -> { - _torController.stopTor() - _torConnectScreen.value = ConnectAssistUiState.ConnectionAssist - } + override fun onBootstrapStageChange(stage: TorConnectStage?) { + torConnectStage.value = stage + }
- ConnectAssistUiState.LocationError -> { - _torConnectScreen.value = ConnectAssistUiState.ConnectionAssist - } + override fun onBootstrapProgress(progress: Double, hasWarnings: Boolean) {}
- ConnectAssistUiState.LocationCheck -> { - _torConnectScreen.value = ConnectAssistUiState.LocationError - } + override fun onBootstrapComplete() {}
- ConnectAssistUiState.LastTry -> { - _torController.stopTor() - _torConnectScreen.value = ConnectAssistUiState.LocationCheck - } + override fun onBootstrapError( + code: String?, + message: String?, + phase: String?, + reason: String?, + ) {}
- ConnectAssistUiState.FinalError -> { - _torConnectScreen.value = ConnectAssistUiState.LocationCheck - } - } + fun button1ShouldBeDisabled(screen: ConnectAssistUiState): Boolean { + return selectedCountryCode.value == "automatic" && screen.countryDropDownDefaultItem == R.string.connection_assist_select_country_or_region } }
===================================== mobile/android/fenix/app/src/main/java/org/mozilla/fenix/tor/UrlQuickLoadViewModel.kt ===================================== @@ -1,10 +1,26 @@ package org.mozilla.fenix.tor
+import android.app.Application +import androidx.lifecycle.AndroidViewModel import androidx.lifecycle.MutableLiveData -import androidx.lifecycle.ViewModel +import org.mozilla.fenix.ext.components +import org.mozilla.geckoview.TorConnectStageName + +class UrlQuickLoadViewModel(application: Application) : AndroidViewModel(application) { + + private val torAndroidIntegration = + application.components.core.geckoRuntime.torIntegrationController
-class UrlQuickLoadViewModel : ViewModel() { val urlToLoadAfterConnecting: MutableLiveData<String?> by lazy { MutableLiveData<String?>(null) } + + fun maybeBeginBootstrap() { + when (torAndroidIntegration.lastKnowStage.value?.name) { + TorConnectStageName.Offline -> torAndroidIntegration.beginBootstrap() + TorConnectStageName.Start -> torAndroidIntegration.beginBootstrap() + else -> {} + } + } + }
===================================== mobile/android/fenix/app/src/main/res/layout/fragment_tor_connection_assist.xml ===================================== @@ -45,6 +45,7 @@ android:layout_marginStart="8dp" android:layout_marginTop="8dp" android:visibility="invisible" + android:contentDescription="@string/connection_assist_back_button_content_description_start_again" app:layout_constraintStart_toStartOf="parent" app:layout_constraintTop_toTopOf="parent">
===================================== mobile/android/fenix/app/src/main/res/values/colors.xml ===================================== @@ -380,6 +380,8 @@
<!-- Connection Assist --> <color name="connect_button_purple">#9059FF</color> + <color name="disabled_connect_button_purple">#5C42A9</color> + <color name="disabled_text_gray_purple">#8782A9</color> <color name="configure_connection_button_white">#E1E0E7</color> <color name="warning_yellow">#FFA436</color> <color name="progress_background_tint">#55148C</color>
===================================== mobile/android/fenix/app/src/main/res/values/torbrowser_strings.xml ===================================== @@ -78,7 +78,9 @@ <!-- Connection assist. --> <string name="connection_assist_unblock_the_internet_in_country_or_region">Unblock the internet in:</string> <!-- Connection assist. --> - <string name="connection_assist_share_my_location_country_or_region">Share my location</string> + <string name="connection_assist_automatic_country_detection">Automatic</string> + <!-- Connection assist, --> + <string name="connection_assist_select_country_or_region">Select country or region</string> <!-- Connection assist. --> <string name="connection_assist_try_a_bridge_button">Try a bridge</string>
@@ -122,5 +124,7 @@ <string name="connection_assist_connect_to_tor_before_opening_links">Connect to Tor before opening links</string> <!-- Connection assist. Confirmation button for a shown "Snackbar" (special popup notification). --> <string name="connection_assist_connect_to_tor_before_opening_links_confirmation">CONNECT</string> + <!-- Connection assist. Content Description for back button. Button will start the connection assist process again --> + <string name="connection_assist_back_button_content_description_start_again">Start again</string>
</resources>
===================================== mobile/android/geckoview/src/main/java/org/mozilla/geckoview/TorAndroidIntegration.java ===================================== @@ -10,6 +10,8 @@ import android.content.Context; import android.os.AsyncTask; import android.util.Log; import androidx.annotation.NonNull; +import androidx.lifecycle.LiveData; +import androidx.lifecycle.MutableLiveData; import java.io.BufferedReader; import java.io.File; import java.io.FileOutputStream; @@ -53,8 +55,10 @@ public class TorAndroidIntegration implements BundleEventListener { private static final String EVENT_BOOTSTRAP_BEGIN_AUTO = "GeckoView:Tor:BootstrapBeginAuto"; private static final String EVENT_BOOTSTRAP_CANCEL = "GeckoView:Tor:BootstrapCancel"; private static final String EVENT_BOOTSTRAP_GET_STATE = "GeckoView:Tor:BootstrapGetState"; + private static final String EVENT_START_AGAIN = "GeckoView:Tor:StartAgain"; private static final String EVENT_QUICKSTART_GET = "GeckoView:Tor:QuickstartGet"; private static final String EVENT_QUICKSTART_SET = "GeckoView:Tor:QuickstartSet"; + private static final String EVENT_COUNTRY_NAMES_GET = "GeckoView:Tor:CountryNamesGet";
private static final String CONTROL_PORT_FILE = "/control-ipc"; private static final String SOCKS_FILE = "/socks-ipc"; @@ -82,6 +86,9 @@ public class TorAndroidIntegration implements BundleEventListener {
private int mMeekCounter;
+ private final MutableLiveData<TorConnectStage> _lastKnownStage = new MutableLiveData<>(null); + public LiveData<TorConnectStage> lastKnowStage = _lastKnownStage; + /** * mSettings is a Java-side copy of the authoritative settings in the JS code. It's useful to * maintain as the UI may be fetching these options often and we don't watch each fetch to be a @@ -154,6 +161,7 @@ public class TorAndroidIntegration implements BundleEventListener { } } else if (EVENT_CONNECT_STAGE_CHANGED.equals(event)) { TorConnectStage stage = new TorConnectStage(message.getBundle("stage")); + _lastKnownStage.setValue(stage); for (BootstrapStateChangeListener listener : mBootstrapStateListeners) { listener.onBootstrapStageChange(stage); } @@ -693,6 +701,10 @@ public class TorAndroidIntegration implements BundleEventListener { return EventDispatcher.getInstance().queryVoid(EVENT_SETTINGS_SET, bundle); }
+ public @NonNull GeckoResult<Void> startAgain() { + return EventDispatcher.getInstance().queryVoid(EVENT_START_AGAIN); + } + public interface QuickstartGetter { void onValue(boolean enabled); } @@ -710,6 +722,17 @@ public class TorAndroidIntegration implements BundleEventListener { return EventDispatcher.getInstance().queryVoid(EVENT_QUICKSTART_SET, bundle); }
+ public interface CountryNamesGetter { + void onValue(GeckoBundle regions); + } + + public void countryNamesGet(CountryNamesGetter countryNamesGetter) { + EventDispatcher.getInstance().queryBundle(EVENT_COUNTRY_NAMES_GET).then(countryNames -> { + countryNamesGetter.onValue(countryNames); + return new GeckoResult<Void>(); + }); + } + public @NonNull GeckoResult<Void> beginBootstrap() { return EventDispatcher.getInstance().queryVoid(EVENT_BOOTSTRAP_BEGIN); }
===================================== toolkit/modules/TorAndroidIntegration.sys.mjs ===================================== @@ -42,8 +42,10 @@ const ListenedEvents = Object.freeze({ bootstrapBeginAuto: "GeckoView:Tor:BootstrapBeginAuto", bootstrapCancel: "GeckoView:Tor:BootstrapCancel", bootstrapGetState: "GeckoView:Tor:BootstrapGetState", + startAgain: "GeckoView:Tor:StartAgain", quickstartGet: "GeckoView:Tor:QuickstartGet", quickstartSet: "GeckoView:Tor:QuickstartSet", + countryNamesGet: "GeckoView:Tor:CountryNamesGet", });
class TorAndroidIntegrationImpl { @@ -190,14 +192,18 @@ class TorAndroidIntegrationImpl { case ListenedEvents.bootstrapGetState: callback?.onSuccess(lazy.TorConnect.state); return; - // TODO: Expose TorConnect.startAgain() to allow users to begin - // from the start again. + case ListenedEvents.startAgain: + lazy.TorConnect.startAgain(); + break; case ListenedEvents.quickstartGet: callback?.onSuccess(lazy.TorConnect.quickstart); return; case ListenedEvents.quickstartSet: lazy.TorConnect.quickstart = data.enabled; break; + case ListenedEvents.countryNamesGet: + callback?.onSuccess(lazy.TorConnect.countryNames); + return; } callback?.onSuccess(); } catch (e) {
View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/compare/797d5a0...
tor-commits@lists.torproject.org
-
Dan Ballard (＠dan)