Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract Main Menu to Fragment to prevent lifecycle crashes #5829

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Extract Main Menu to Fragment to prevent lifecycle crashes #5829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f343d3
Extract main menu to fragment
seadowg Nov 9, 2023
5d3e41c
Specify fragment in layout
seadowg Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
288 changes: 18 additions & 270 deletions collect_app/src/main/java/org/odk/collect/android/mainmenu/MainMenuActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,20 @@
package org.odk.collect.android.mainmenu

import android.content.Intent
import android.net.Uri
import android.os.Build
import android.os.Bundle
import android.view.Menu
import android.view.MenuItem
import android.view.View
import androidx.activity.result.contract.ActivityResultContracts
import androidx.appcompat.widget.Toolbar
import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
import androidx.lifecycle.ViewModelProvider
import org.odk.collect.android.R
import org.odk.collect.android.activities.ActivityUtils
import org.odk.collect.android.activities.CrashHandlerActivity
import org.odk.collect.android.activities.DeleteSavedFormActivity
import org.odk.collect.android.activities.FirstLaunchActivity
import org.odk.collect.android.activities.FormDownloadListActivity
import org.odk.collect.android.activities.InstanceChooserList
import org.odk.collect.android.activities.InstanceUploaderListActivity
import org.odk.collect.android.activities.WebViewActivity
import org.odk.collect.android.application.MapboxClassInstanceCreator.createMapBoxInitializationFragment
import org.odk.collect.android.application.MapboxClassInstanceCreator.isMapboxAvailable
import org.odk.collect.android.databinding.MainMenuBinding
import org.odk.collect.android.formlists.blankformlist.BlankFormListActivity
import org.odk.collect.android.formmanagement.FormFillingIntentFactory
import org.odk.collect.android.gdrive.GoogleDriveActivity
import org.odk.collect.android.injection.DaggerUtils
import org.odk.collect.android.projects.ProjectIconView
import org.odk.collect.android.projects.ProjectSettingsDialog
import org.odk.collect.android.utilities.ApplicationConstants
import org.odk.collect.android.utilities.ApplicationConstants.AppStateKeys.EDITED_FINALIZED_FORM
import org.odk.collect.android.utilities.PlayServicesChecker
import org.odk.collect.android.utilities.ThemeUtils
import org.odk.collect.androidshared.data.getState
import org.odk.collect.androidshared.ui.DialogFragmentUtils.showIfNotShowing
import org.odk.collect.androidshared.ui.FragmentFactoryBuilder
import org.odk.collect.androidshared.ui.SnackbarUtils
import org.odk.collect.androidshared.ui.multiclicksafe.MultiClickGuard.allowClick
import org.odk.collect.crashhandler.CrashHandler
import org.odk.collect.permissions.PermissionsProvider
import org.odk.collect.projects.Project.Saved
import org.odk.collect.settings.SettingsProvider
import org.odk.collect.settings.keys.ProjectKeys
import org.odk.collect.strings.R.string
import org.odk.collect.strings.localization.LocalizedActivity
import javax.inject.Inject

Expand All @@ -58,15 +29,8 @@ class MainMenuActivity : LocalizedActivity() {
@Inject
lateinit var permissionsProvider: PermissionsProvider

private lateinit var binding: MainMenuBinding
private lateinit var mainMenuViewModel: MainMenuViewModel
private lateinit var currentProjectViewModel: CurrentProjectViewModel

private val formEntryFlowLauncher =
registerForActivityResult(ActivityResultContracts.StartActivityForResult()) {
displayFormSavedSnackbar(it.data?.data)
}

override fun onCreate(savedInstanceState: Bundle?) {
initSplashScreen()

Expand All @@ -81,98 +45,33 @@ class MainMenuActivity : LocalizedActivity() {
DaggerUtils.getComponent(this).inject(this)

val viewModelProvider = ViewModelProvider(this, viewModelFactory)
mainMenuViewModel = viewModelProvider[MainMenuViewModel::class.java]
currentProjectViewModel = viewModelProvider[CurrentProjectViewModel::class.java]
val permissionsViewModel = viewModelProvider[RequestPermissionsViewModel::class.java]

this.supportFragmentManager.fragmentFactory = FragmentFactoryBuilder()
.forClass(PermissionsDialogFragment::class) {
PermissionsDialogFragment(
permissionsProvider,
permissionsViewModel
)
}
.forClass(ProjectSettingsDialog::class) {
ProjectSettingsDialog(viewModelFactory)
}
.build()

super.onCreate(savedInstanceState)
binding = MainMenuBinding.inflate(layoutInflater)

ThemeUtils(this).setDarkModeForCurrentProject()

if (!currentProjectViewModel.hasCurrentProject()) {
super.onCreate(null)
ActivityUtils.startActivityAndCloseAllOthers(this, FirstLaunchActivity::class.java)
return
}

setContentView(binding.root)

currentProjectViewModel.currentProject.observe(this) { (_, name): Saved ->
invalidateOptionsMenu()
title = name
}

initToolbar()
initMapbox()
initButtons()
initAppName()

if (permissionsViewModel.shouldAskForPermissions()) {
showIfNotShowing(PermissionsDialogFragment::class.java, this.supportFragmentManager)
}
}

override fun onResume() {
super.onResume()
if (isFinishing) {
return // Guard against onResume calls after we've finished in onCreate
}

currentProjectViewModel.refresh()
mainMenuViewModel.refreshInstances()
setButtonsVisibility()
setupDeprecationBanner()
}

private fun setButtonsVisibility() {
binding.reviewData.visibility =
if (mainMenuViewModel.shouldEditSavedFormButtonBeVisible()) View.VISIBLE else View.GONE
binding.sendData.visibility =
if (mainMenuViewModel.shouldSendFinalizedFormButtonBeVisible()) View.VISIBLE else View.GONE
binding.viewSentForms.visibility =
if (mainMenuViewModel.shouldViewSentFormButtonBeVisible()) View.VISIBLE else View.GONE
binding.getForms.visibility =
if (mainMenuViewModel.shouldGetBlankFormButtonBeVisible()) View.VISIBLE else View.GONE
binding.manageForms.visibility =
if (mainMenuViewModel.shouldDeleteSavedFormButtonBeVisible()) View.VISIBLE else View.GONE
}

override fun onPrepareOptionsMenu(menu: Menu): Boolean {
val projectsMenuItem = menu.findItem(R.id.projects)
(projectsMenuItem.actionView as ProjectIconView).apply {
project = currentProjectViewModel.currentProject.value
setOnClickListener { onOptionsItemSelected(projectsMenuItem) }
contentDescription = getString(string.projects)
}
return super.onPrepareOptionsMenu(menu)
}

override fun onCreateOptionsMenu(menu: Menu): Boolean {
menuInflater.inflate(R.menu.main_menu, menu)
return super.onCreateOptionsMenu(menu)
}
} else {
this.supportFragmentManager.fragmentFactory = FragmentFactoryBuilder()
.forClass(PermissionsDialogFragment::class) {
PermissionsDialogFragment(
permissionsProvider,
viewModelProvider[RequestPermissionsViewModel::class.java]
)
}
.forClass(ProjectSettingsDialog::class) {
ProjectSettingsDialog(viewModelFactory)
}
.forClass(MainMenuFragment::class) {
MainMenuFragment(viewModelFactory, settingsProvider)
}
.build()

override fun onOptionsItemSelected(item: MenuItem): Boolean {
if (!allowClick(javaClass.name)) {
return true
}
if (item.itemId == R.id.projects) {
showIfNotShowing(ProjectSettingsDialog::class.java, supportFragmentManager)
return true
super.onCreate(savedInstanceState)
setContentView(R.layout.main_menu_activity)
}
return super.onOptionsItemSelected(item)
}

private fun initSplashScreen() {
Expand All @@ -187,155 +86,4 @@ class MainMenuActivity : LocalizedActivity() {
setTheme(R.style.Theme_Collect)
}
}

private fun initToolbar() {
val toolbar = findViewById<Toolbar>(R.id.toolbar)
setSupportActionBar(toolbar)
}

private fun initMapbox() {
if (isMapboxAvailable()) {
supportFragmentManager
.beginTransaction()
.add(R.id.map_box_initialization_fragment, createMapBoxInitializationFragment()!!)
.commit()
}
}

private fun initButtons() {
binding.enterData.setOnClickListener {
formEntryFlowLauncher.launch(
Intent(this, BlankFormListActivity::class.java)
)
}

binding.reviewData.setOnClickListener {
formEntryFlowLauncher.launch(
Intent(this, InstanceChooserList::class.java).apply {
putExtra(
ApplicationConstants.BundleKeys.FORM_MODE,
ApplicationConstants.FormModes.EDIT_SAVED
)
}
)
}

binding.sendData.setOnClickListener {
formEntryFlowLauncher.launch(Intent(this, InstanceUploaderListActivity::class.java))
}

binding.viewSentForms.setOnClickListener {
startActivity(
Intent(this, InstanceChooserList::class.java).apply {
putExtra(
ApplicationConstants.BundleKeys.FORM_MODE,
ApplicationConstants.FormModes.VIEW_SENT
)
}
)
}

binding.getForms.setOnClickListener(
View.OnClickListener {
val protocol =
settingsProvider.getUnprotectedSettings().getString(ProjectKeys.KEY_PROTOCOL)
val intent =
if (protocol.equals(ProjectKeys.PROTOCOL_GOOGLE_SHEETS, ignoreCase = true)) {
if (PlayServicesChecker().isGooglePlayServicesAvailable(this@MainMenuActivity)) {
Intent(
applicationContext,
GoogleDriveActivity::class.java
)
} else {
PlayServicesChecker().showGooglePlayServicesAvailabilityErrorDialog(this@MainMenuActivity)
return@OnClickListener
}
} else {
Intent(
applicationContext,
FormDownloadListActivity::class.java
)
}
startActivity(intent)
}
)

binding.manageForms.setOnClickListener {
startActivity(Intent(this, DeleteSavedFormActivity::class.java))
}

mainMenuViewModel.sendableInstancesCount.observe(this) { finalized: Int ->
binding.sendData.setNumberOfForms(finalized)
}
mainMenuViewModel.editableInstancesCount.observe(this) { unsent: Int ->
binding.reviewData.setNumberOfForms(unsent)
}
mainMenuViewModel.sentInstancesCount.observe(this) { sent: Int ->
binding.viewSentForms.setNumberOfForms(sent)
}
}

private fun initAppName() {
binding.appName.text = String.format(
"%s %s",
getString(string.collect_app_name),
mainMenuViewModel.version
)

val versionSHA = mainMenuViewModel.versionCommitDescription
if (versionSHA != null) {
binding.versionSha.text = versionSHA
} else {
binding.versionSha.visibility = View.GONE
}
}

private fun setupDeprecationBanner() {
val unprotectedSettings = settingsProvider.getUnprotectedSettings()
val protocol = unprotectedSettings.getString(ProjectKeys.KEY_PROTOCOL)
val usingGoogleDrive = ProjectKeys.PROTOCOL_GOOGLE_SHEETS == protocol
val editedFinalizedForm =
application.getState().get<Boolean>(EDITED_FINALIZED_FORM) ?: false

if (usingGoogleDrive) {
binding.deprecationBanner.root.visibility = View.VISIBLE
binding.deprecationBanner.message.setText(string.google_drive_deprecation_message)
binding.deprecationBanner.learnMoreButton.setOnClickListener {
val intent = Intent(this, WebViewActivity::class.java)
intent.putExtra("url", "https://forum.getodk.org/t/40097")
startActivity(intent)
}
} else if (editedFinalizedForm) {
binding.deprecationBanner.root.visibility = View.VISIBLE
binding.deprecationBanner.message.setText(string.edit_finalized_form_deprecation_message)
binding.deprecationBanner.learnMoreButton.setOnClickListener {
val intent = Intent(this, WebViewActivity::class.java)
intent.putExtra("url", "https://forum.getodk.org/t/42007")
startActivity(intent)
}
} else {
binding.deprecationBanner.root.visibility = View.GONE
}
}

private fun displayFormSavedSnackbar(uri: Uri?) {
if (uri == null) {
return
}

val formSavedSnackbarDetails = mainMenuViewModel.getFormSavedSnackbarDetails(uri)

formSavedSnackbarDetails?.let {
SnackbarUtils.showLongSnackbar(
binding.root,
getString(it.first),
action = it.second?.let { action ->
SnackbarUtils.Action(getString(action)) {
formEntryFlowLauncher.launch(FormFillingIntentFactory.editInstanceIntent(this, uri))
}
},
displayDismissButton = true
)
}
}
}
Loading