Skip to content

Commit

Permalink
handled deeplink for opening form with preselected values
Browse files Browse the repository at this point in the history
  • Loading branch information
@itheamc
itheamc committed Jul 5, 2024
1 parent b2012ba commit 335fd6c
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 58 deletions.
29 changes: 15 additions & 14 deletions collect_app/src/main/AndroidManifest.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ the specific language governing permissions and limitations under the License.
This intent-filter enables the launching of FirstLaunchActivity
via in-browser links in the format
"odkcollect://project/configuration?data=<settings-data>"
to set up the project.
-->
<intent-filter>
<action android:name="android.intent.action.VIEW"/>
Expand Down Expand Up @@ -134,20 +135,7 @@ the specific language governing permissions and limitations under the License.
<activity
android:name=".activities.FormFillingActivity"
android:theme="@style/Theme.Collect.FormEntry"
android:windowSoftInputMode="adjustResize"
android:exported="true">
<!--
This intent-filter enables the launching of FormFillingActivity
on a specific form via in-browser links in the format
"odkcollect://form/<form_id>" (see FormLoaderTask for details).
-->
<intent-filter>
<action android:name="android.intent.action.VIEW"/>
<data android:scheme="odkcollect" android:host="form" />
<category android:name="android.intent.category.DEFAULT"/>
<category android:name="android.intent.category.BROWSABLE"/>
</intent-filter>
</activity>
android:windowSoftInputMode="adjustResize" />
<activity
android:name="org.odk.collect.draw.DrawActivity"
android:screenOrientation="landscape" />
Expand Down Expand Up @@ -350,6 +338,19 @@ the specific language governing permissions and limitations under the License.
<data android:mimeType="vnd.android.cursor.item/vnd.odk.form" />
<data android:mimeType="vnd.android.cursor.item/vnd.odk.instance" />
</intent-filter>

<!--
This intent-filter enables the launching of FormUriActivity
via in-browser links in the format
"odkcollect://form/<form_id>" (see FormUriActivity for details).
It leads to open the form with the given form id with pre filled forms
-->
<intent-filter>
<action android:name="android.intent.action.VIEW"/>
<data android:scheme="odkcollect" android:host="form" />
<category android:name="android.intent.category.DEFAULT"/>
<category android:name="android.intent.category.BROWSABLE"/>
</intent-filter>
</activity>

</application>
Expand Down
152 changes: 123 additions & 29 deletions collect_app/src/main/java/org/odk/collect/android/external/FormUriActivity.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,23 +87,29 @@ class FormUriActivity : ComponentActivity() {
DaggerUtils.getComponent(this).inject(this)
setContentView(R.layout.circular_progress_indicator)

formUriViewModel.error.observe(this) {
if (it != null) {
displayErrorDialog(it)
} else if (savedInstanceState?.getBoolean(FORM_FILLING_ALREADY_STARTED) != true) {
startForm()
formUriViewModel.formUriValidationResult.observe(this) {
when (it) {
is Valid -> {
if (savedInstanceState?.getBoolean(FORM_FILLING_ALREADY_STARTED) != true) {
startForm(it.uri)
}
}

is Invalid -> {
displayErrorDialog(it.message)
}
}
}
}

private fun startForm() {
private fun startForm(uri: Uri) {
formFillingAlreadyStarted = true
openForm.launch(
Intent(this, FormFillingActivity::class.java).apply {
action = intent.action
data = intent.data
data = uri
intent.extras?.let { sourceExtras -> putExtras(sourceExtras) }
if (!canFormBeEdited()) {
if (!canFormBeEdited(uri)) {
putExtra(
ApplicationConstants.BundleKeys.FORM_MODE,
ApplicationConstants.FormModes.VIEW_SENT
Expand All @@ -122,8 +128,7 @@ class FormUriActivity : ComponentActivity() {
.show()
}

private fun canFormBeEdited(): Boolean {
val uri = intent.data!!
private fun canFormBeEdited(uri: Uri): Boolean {
val uriMimeType = contentResolver.getType(uri)

val formEditingEnabled = if (uriMimeType == InstancesContract.CONTENT_ITEM_TYPE) {
Expand Down Expand Up @@ -157,23 +162,79 @@ private class FormUriViewModel(
private val resources: Resources
) : ViewModel() {

private val _error = MutableLiveData<String?>()
val error: LiveData<String?> = _error

// This is just for handling and reassigning uri
// When the FormUriActivity is started via a browsable link in
// the format "odkcollect://form/<form_id>"
private var _uri: Uri? = uri

private val _formUriValidationResult = MutableLiveData<FormUriValidationResult>()
val formUriValidationResult: LiveData<FormUriValidationResult> = _formUriValidationResult

init {
scheduler.immediate(
background = {
// If from the browsable link in the format "odkcollect://form/<form_id>",
// We will modify the uri to make it valid for the FormFillingActivity
if (uri?.scheme == "odkcollect" && uri.host == "form") {

// Get the form id from the uri
val formId = ContentUriHelper.getIdFromUri(uri)

// If the form id is not valid i.e. -1, return with error message
if (formId == -1L) {
return@immediate "${resources.getString(string.wrong_project_selected_for_form)} And conform that it is downloaded."
}

// Getting currently active project id
val currentProjectId = try {
projectsDataService.getCurrentProject().uuid
} catch (e: Exception) {
null
}

// Else build the new uri
// We will modify the uri to make it valid for the FormFillingActivity
val tempUri = FormsContract.getUri(null)
val builder = Uri.Builder()
.scheme(tempUri.scheme)
.authority(tempUri.authority)
.appendPath(tempUri.lastPathSegment)
.appendPath(ContentUriHelper.getIdFromUri(uri).toString())

// If projectId is not present in the uri, add it
if (!uri.queryParameterNames.contains("projectId")) {
builder.appendQueryParameter("projectId", currentProjectId)
}

// add all the query parameters from the uri
uri.queryParameterNames?.forEach { key ->
builder.appendQueryParameter(key, uri.getQueryParameter(key))
}

// Build the new uri
_uri = builder.build()
}

assertProjectListNotEmpty() ?: assertCurrentProjectUsed() ?: assertValidUri()
?: assertFormExists() ?: assertFormNotEncrypted()
?: assertFormExists() ?: assertFormNotEncrypted()
},
foreground = {
_error.value = it
_formUriValidationResult.value = if (it == null) {
Valid(_uri!!)
} else {
Invalid(it)
}
}
)
}

private fun assertProjectListNotEmpty(): String? {
val projects = projectsRepository.getAll()
val projects = try {
projectsRepository.getAll()
} catch (e: Exception) {
emptyList()
}
return if (projects.isEmpty()) {
resources.getString(string.app_not_configured)
} else {
Expand All @@ -182,20 +243,28 @@ private class FormUriViewModel(
}

private fun assertCurrentProjectUsed(): String? {
val projects = projectsRepository.getAll()
val firstProject = projects.first()
val uriProjectId = uri?.getQueryParameter("projectId")
val projectId = uriProjectId ?: firstProject.uuid
val uriProjectId = _uri?.getQueryParameter("projectId")
val projectId = if (uriProjectId != null) uriProjectId else {
val projects = projectsRepository.getAll()
val firstProject = projects.first()
firstProject.uuid
}

return if (projectId != projectsDataService.getCurrentProject().uuid) {
val currentProjectId = try {
projectsDataService.getCurrentProject().uuid
} catch (e: Exception) {
null
}

return if (projectId != currentProjectId) {
resources.getString(string.wrong_project_selected_for_form)
} else {
null
}
}

private fun assertValidUri(): String? {
val isUriValid = uri?.let {
val isUriValid = _uri?.let {
val uriMimeType = contentResolver.getType(it)
if (uriMimeType == null) {
false
Expand All @@ -212,21 +281,23 @@ private class FormUriViewModel(
}

private fun assertFormExists(): String? {
val uriMimeType = contentResolver.getType(uri!!)
val uriMimeType = contentResolver.getType(_uri!!)

return if (uriMimeType == FormsContract.CONTENT_ITEM_TYPE) {
val formExists =
formsRepositoryProvider.get().get(ContentUriHelper.getIdFromUri(uri))?.let {
File(it.formFilePath).exists()
} ?: false
formsRepositoryProvider.get().get(ContentUriHelper.getIdFromUri(_uri!!))
?.let {
File(it.formFilePath).exists()
} ?: false

if (formExists) {
null
} else {
resources.getString(string.bad_uri)
}
} else {
val instance = instancesRepositoryProvider.get().get(ContentUriHelper.getIdFromUri(uri))
val instance =
instancesRepositoryProvider.get().get(ContentUriHelper.getIdFromUri(_uri!!))
if (instance == null) {
resources.getString(string.bad_uri)
} else if (!File(instance.instanceFilePath).exists()) {
Expand All @@ -247,7 +318,10 @@ private class FormUriViewModel(
"\n${resources.getString(string.version)} ${instance.formVersion}"
}

resources.getString(string.parent_form_not_present, "${instance.formId}$version")
resources.getString(
string.parent_form_not_present,
"${instance.formId}$version"
)
} else if (candidateForms.filter { !it.isDeleted }.size > 1) {
resources.getString(string.survey_multiple_forms_error)
} else {
Expand All @@ -258,10 +332,11 @@ private class FormUriViewModel(
}

private fun assertFormNotEncrypted(): String? {
val uriMimeType = contentResolver.getType(uri!!)
val uriMimeType = contentResolver.getType(_uri!!)

return if (uriMimeType == InstancesContract.CONTENT_ITEM_TYPE) {
val instance = instancesRepositoryProvider.get().get(ContentUriHelper.getIdFromUri(uri))
val instance =
instancesRepositoryProvider.get().get(ContentUriHelper.getIdFromUri(_uri!!))
if (instance!!.canEditWhenComplete()) {
null
} else {
Expand All @@ -272,3 +347,22 @@ private class FormUriViewModel(
}
}
}

/**
* Represents the result of validating a form URI.
*It can either be a [Valid] containing the valid URI,
* or an [Invalid] with an error message.
*/
private sealed class FormUriValidationResult

/**
* Represents a successfully validated form URI.
* @property uri The valid URI.
*/
private data class Valid(val uri: Uri) : FormUriValidationResult()

/**
* Represents an invalid form URI with an associated error message.
* @property message The error message explaining why the URI is invalid.
*/
private data class Invalid(val message: String) : FormUriValidationResult()
12 changes: 0 additions & 12 deletions collect_app/src/main/java/org/odk/collect/android/tasks/FormLoaderTask.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@
import java.io.IOException;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Set;

import timber.log.Timber;
Expand Down Expand Up @@ -182,17 +181,6 @@ protected FECWrapper doInBackground(Void... ignored) {
* explicitly saved instance is edited via edit-saved-form.
*/
instancePath = loadSavePoint();
} else if (Objects.equals(uri.getScheme(), "odkcollect") && Objects.equals(uri.getHost(), "form")) {
// When the FormFillingActivity is started via a browsable link in
// the format "odkcollect://form/<form_id>", we want to launch and
// load the form with the specified Form ID. (<form_id> is the
// form ID in the form definition, not the local form ID.)
form = new FormsRepositoryProvider(Collect.getInstance()).get().get(ContentUriHelper.getIdFromUri(uri));
if (form == null) {
Timber.e(new Error("form is null"));
errorMsg = "This form no longer exists, please email [email protected] with a description of what you were doing when this happened.";
return null;
}
}

if (form.getFormFilePath() == null) {
Expand Down
12 changes: 9 additions & 3 deletions collect_app/src/main/java/org/odk/collect/android/utilities/ContentUriHelper.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,23 @@ import android.provider.MediaStore
import android.webkit.MimeTypeMap
import org.odk.collect.android.application.Collect
import org.odk.collect.forms.Form
import timber.log.Timber

object ContentUriHelper {

@JvmStatic
fun getIdFromUri(contentUri: Uri): Long {
val idSegment = contentUri.pathSegments.last()
if (idSegment.toLongOrNull() == null) {
val forms: List<Form> =
FormsRepositoryProvider(Collect.getInstance()).get().getAllByFormId(idSegment)
try {
val forms: List<Form> =
FormsRepositoryProvider(Collect.getInstance()).get().getAllByFormId(idSegment)
return forms.firstOrNull()?.dbId ?: -1
} catch (e: Exception) {
Timber.e("Error getting form id: %s", e.message)
}

return forms.firstOrNull()?.dbId ?: -1
return -1
}

return idSegment.toLong()
Expand Down

0 comments on commit 335fd6c

Please sign in to comment.