Add Location co-ordinates on questionnaire submission #2997
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,19 +16,33 @@ | |
|
|
||
| package org.smartregister.fhircore.quest.ui.questionnaire | ||
|
|
||
| import android.Manifest | ||
| import android.annotation.SuppressLint | ||
| import android.app.Activity | ||
| import android.app.AlertDialog | ||
| import android.content.Intent | ||
| import android.content.pm.PackageManager | ||
| import android.location.Location | ||
| import android.os.Bundle | ||
| import android.os.Parcelable | ||
| import android.provider.Settings | ||
| import android.view.View | ||
| import android.widget.Toast | ||
| import androidx.activity.OnBackPressedCallback | ||
| import androidx.activity.result.contract.ActivityResultContracts | ||
| import androidx.activity.viewModels | ||
| import androidx.core.app.ActivityCompat | ||
| import androidx.core.os.bundleOf | ||
| import androidx.fragment.app.commit | ||
| import androidx.lifecycle.lifecycleScope | ||
| import com.google.android.fhir.datacapture.QuestionnaireFragment | ||
| import com.google.android.fhir.logicalId | ||
| import com.google.android.gms.location.FusedLocationProviderClient | ||
| import com.google.android.gms.location.LocationServices | ||
| import com.google.android.gms.location.Priority | ||
| import com.google.android.gms.tasks.CancellationToken | ||
| import com.google.android.gms.tasks.CancellationTokenSource | ||
| import com.google.android.gms.tasks.OnTokenCanceledListener | ||
| import dagger.hilt.android.AndroidEntryPoint | ||
| import java.io.Serializable | ||
| import java.util.LinkedList | ||
|
|
@@ -62,8 +76,19 @@ class QuestionnaireActivity : BaseMultiLanguageActivity() { | |
| private var questionnaire: Questionnaire? = null | ||
| private var alertDialog: AlertDialog? = null | ||
|
|
||
| private lateinit var fusedLocationClient: FusedLocationProviderClient | ||
| private val loc = org.hl7.fhir.r4.model.Location() | ||
|
|
||
| override fun onCreate(savedInstanceState: Bundle?) { | ||
| super.onCreate(savedInstanceState) | ||
|
|
||
| val applicationConfiguration = viewModel.applicationConfiguration | ||
|
|
||
| if (applicationConfiguration.logQuestionnaireLocation) { | ||
| fusedLocationClient = LocationServices.getFusedLocationProviderClient(this) | ||
| getLocation() | ||
|
There was a problem hiding this comment. is this running in the foreground or background? If there is not a GPS fix, what happens? There was a problem hiding this comment. @pld There are some updates to the flow. The GPS location request is made in the background when a questionnaire is launched. This is done after config, permissions and location services checks are complete. On submit, the GPS location - if available - is used to create the location resource. |
||
| } | ||
|
|
||
| setTheme(R.style.AppTheme_Questionnaire) | ||
| viewBinding = QuestionnaireActivityBinding.inflate(layoutInflater) | ||
| setContentView(viewBinding.root) | ||
|
|
@@ -231,6 +256,9 @@ class QuestionnaireActivity : BaseMultiLanguageActivity() { | |
| if (questionnaireResponse != null && questionnaire != null) { | ||
| viewModel.run { | ||
| setProgressState(QuestionnaireProgressState.ExtractionInProgress(true)) | ||
|
|
||
| questionnaireResponse.contained.add(loc) | ||
|
|
||
| handleQuestionnaireSubmission( | ||
| questionnaire = questionnaire!!, | ||
| currentQuestionnaireResponse = questionnaireResponse, | ||
|
|
@@ -251,11 +279,112 @@ class QuestionnaireActivity : BaseMultiLanguageActivity() { | |
| ) | ||
| finish() | ||
| } | ||
| // do background location processing | ||
| // check here that "logQuestionnaireLocation": true | ||
DebbieArita marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun getLocation() { | ||
DebbieArita marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if ( | ||
| ActivityCompat.checkSelfPermission( | ||
| this@QuestionnaireActivity, | ||
| Manifest.permission.ACCESS_FINE_LOCATION, | ||
| ) != PackageManager.PERMISSION_GRANTED && | ||
| ActivityCompat.checkSelfPermission( | ||
| this@QuestionnaireActivity, | ||
| Manifest.permission.ACCESS_COARSE_LOCATION, | ||
| ) != PackageManager.PERMISSION_GRANTED | ||
| ) { | ||
| val locationPermissionRequest = | ||
| [email protected]( | ||
| ActivityResultContracts.RequestMultiplePermissions(), | ||
| ) { permissions -> | ||
| when { | ||
| permissions.getOrDefault(Manifest.permission.ACCESS_FINE_LOCATION, false) -> { | ||
| getCurrentLocation() | ||
| } | ||
| permissions.getOrDefault(Manifest.permission.ACCESS_COARSE_LOCATION, false) -> { | ||
| // request approx permissions | ||
| getCurrentApproximateLocation() | ||
| } | ||
| else -> { | ||
| // No location access granted. Notify and fail | ||
| Toast.makeText( | ||
| this, | ||
| "Location Access Permission not granted", | ||
| Toast.LENGTH_LONG, | ||
| ) | ||
| .show() | ||
| } | ||
| } | ||
| } | ||
| locationPermissionRequest.launch( | ||
| arrayOf( | ||
| Manifest.permission.ACCESS_FINE_LOCATION, | ||
| Manifest.permission.ACCESS_COARSE_LOCATION, | ||
| ), | ||
| ) | ||
| } else { | ||
| getCurrentLocation() | ||
| } | ||
| } | ||
|
|
||
| @SuppressLint("MissingPermission") | ||
| private fun getCurrentLocation() { | ||
| fusedLocationClient | ||
| .getCurrentLocation( | ||
| Priority.PRIORITY_HIGH_ACCURACY, | ||
| object : CancellationToken() { | ||
| override fun onCanceledRequested(p0: OnTokenCanceledListener) = | ||
| CancellationTokenSource().token | ||
|
|
||
| override fun isCancellationRequested() = false | ||
| }, | ||
| ) | ||
| .addOnSuccessListener { location: Location? -> | ||
| if (location != null) { | ||
| Timber.d("current location${location.latitude} ${location.longitude}") | ||
| loc.position.altitude = location.altitude.toBigDecimal() | ||
| loc.position.latitude = location.latitude.toBigDecimal() | ||
| loc.position.longitude = location.longitude.toBigDecimal() | ||
| } | ||
| } | ||
| .addOnFailureListener { | ||
| // Location services are not enabled, prompt the user to enable them | ||
| val settingsIntent = Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS) | ||
| this.startActivity(settingsIntent) | ||
| } | ||
| } | ||
|
|
||
| @SuppressLint("MissingPermission") | ||
| private fun getCurrentApproximateLocation() { | ||
| fusedLocationClient | ||
| .getCurrentLocation( | ||
| Priority.PRIORITY_BALANCED_POWER_ACCURACY, | ||
| object : CancellationToken() { | ||
| override fun onCanceledRequested(p0: OnTokenCanceledListener) = | ||
| CancellationTokenSource().token | ||
|
|
||
| override fun isCancellationRequested() = false | ||
| }, | ||
| ) | ||
| .addOnSuccessListener { approxLocation: Location? -> | ||
| if (approxLocation != null) { | ||
| Timber.d("current location${approxLocation.latitude} ${approxLocation.longitude}") | ||
| loc.position.altitude = approxLocation.altitude.toBigDecimal() | ||
| loc.position.latitude = approxLocation.latitude.toBigDecimal() | ||
| loc.position.longitude = approxLocation.longitude.toBigDecimal() | ||
| } | ||
| } | ||
| .addOnFailureListener { | ||
| // Location services are not enabled, prompt the user to enable them | ||
| val settingsIntent = Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS) | ||
| this.startActivity(settingsIntent) | ||
| } | ||
| } | ||
|
|
||
| private fun handleBackPress() { | ||
| if (questionnaireConfig.isReadOnly()) { | ||
| finish() | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we know that we will (at some point) want to log location at multiple points, can we change this data structure to reflect that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pld Should we move the setting to
QuestionnaireConfig?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is appropriate here, because in the future we plan to do location logging outside of the Questionnaire flow
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pld Did you have another use case in mind?
In cases where we would need to log the location in multiple places, I'd go with a location config with all options explicitly listed as below:
Usage:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pld Using reflection will not be possible in the application configuration. Kotlin Serialization will be unable to deserialize the type. We could opt for a list of enums instead. Every place that needs location logging will be identified by an enum type.
Example
ApplicationConfiguration
{ "locationLogAreas" : [ "QUESTIONNAIRE" ] }Suggest an appropriate name for the property/class.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK yea if we can't use class names, and maybe that won't map to the semantic anyhow, that's fine, enum seems straightforward.
The other use case I had in mind is that we might want to log the location every 5 minutes. Or if you could complete a task by clicking a button in the profile, we might want to log the location on click
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pld This is noted. We had discussed with @marklosh the need to have a periodic logger for their distance from current location use case since picking the location takes time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have created this issue for the addition of enums to configure location logging
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok let's make the change in this PR before we merge it