Examples with FormInstanceFileCreator org.odk.collect.android.formentry.loading.FormInstanceFileCreator used on opensource projects

Example 1 with FormInstanceFileCreator

use of org.odk.collect.android.formentry.loading.FormInstanceFileCreator in project collect by opendatakit.

the class FormEntryActivity method loadingComplete.

/**
 * Given a {@link FormLoaderTask} which has created a {@link FormController} for either a new or
 * existing instance, shows that instance to the user. Either launches {@link FormHierarchyActivity}
 * if an existing instance is being edited or builds the view for the current question(s) if a
 * new instance is being created.
 * <p>
 * May do some or all of these depending on current state:
 * - Ensures phone state permissions are given if this form needs them
 * - Cleans up {@link #formLoaderTask}
 * - Sets the global form controller and database manager for search()/pulldata()
 * - Restores the last-used language
 * - Handles activity results that may have come in while the form was loading
 * - Alerts the user of a recovery from savepoint
 * - Verifies whether an instance folder exists and creates one if not
 * - Initializes background location capture (only if the instance being loaded is a new one)
 */
@Override
public void loadingComplete(FormLoaderTask task, FormDef formDef, String warningMsg) {
    DialogFragmentUtils.dismissDialog(FormLoadingDialogFragment.class, getSupportFragmentManager());
    final FormController formController = task.getFormController();
    if (formController != null) {
        if (readPhoneStatePermissionRequestNeeded) {
            permissionsProvider.requestReadPhoneStatePermission(this, true, new PermissionListener() {

                @Override
                public void granted() {
                    readPhoneStatePermissionRequestNeeded = false;
                    loadForm();
                }

                @Override
                public void denied() {
                    finish();
                }
            });
        } else {
            formLoaderTask.setFormLoaderListener(null);
            FormLoaderTask t = formLoaderTask;
            formLoaderTask = null;
            t.cancel(true);
            t.destroy();
            Collect.getInstance().setFormController(formController);
            backgroundLocationViewModel.formFinishedLoading();
            Collect.getInstance().setExternalDataManager(task.getExternalDataManager());
            // Set the language if one has already been set in the past
            String[] languageTest = formController.getLanguages();
            if (languageTest != null) {
                String defaultLanguage = formController.getLanguage();
                Form form = formsRepository.getOneByPath(formPath);
                if (form != null) {
                    String newLanguage = form.getLanguage();
                    try {
                        formController.setLanguage(newLanguage);
                    } catch (Exception e) {
                        // if somehow we end up with a bad language, set it to the default
                        Timber.i("Ended up with a bad language. %s", newLanguage);
                        formController.setLanguage(defaultLanguage);
                    }
                }
            }
            boolean pendingActivityResult = task.hasPendingActivityResult();
            if (pendingActivityResult) {
                Timber.w("Calling onActivityResult from loadingComplete");
                formControllerAvailable(formController);
                onScreenRefresh();
                onActivityResult(task.getRequestCode(), task.getResultCode(), task.getIntent());
                return;
            }
            // it can be a normal flow for a pending activity result to restore from a savepoint
            // (the call flow handled by the above if statement). For all other use cases, the
            // user should be notified, as it means they wandered off doing other things then
            // returned to ODK Collect and chose Edit Saved Form, but that the savepoint for
            // that form is newer than the last saved version of their form data.
            boolean hasUsedSavepoint = task.hasUsedSavepoint();
            if (hasUsedSavepoint) {
                runOnUiThread(() -> showLongToast(this, R.string.savepoint_used));
            }
            if (formController.getInstanceFile() == null) {
                FormInstanceFileCreator formInstanceFileCreator = new FormInstanceFileCreator(storagePathProvider, System::currentTimeMillis);
                File instanceFile = formInstanceFileCreator.createInstanceFile(formPath);
                if (instanceFile != null) {
                    formController.setInstanceFile(instanceFile);
                } else {
                    showFormLoadErrorAndExit(getString(R.string.loading_form_failed));
                }
                formControllerAvailable(formController);
                identityPromptViewModel.requiresIdentityToContinue().observe(this, requiresIdentity -> {
                    if (!requiresIdentity) {
                        formController.getAuditEventLogger().logEvent(AuditEvent.AuditEventType.FORM_START, true, System.currentTimeMillis());
                        startFormEntry(formController, warningMsg);
                    }
                });
            } else {
                Intent reqIntent = getIntent();
                boolean showFirst = reqIntent.getBooleanExtra("start", false);
                if (!showFirst) {
                    // we've just loaded a saved form, so start in the hierarchy view
                    String formMode = reqIntent.getStringExtra(ApplicationConstants.BundleKeys.FORM_MODE);
                    if (formMode == null || ApplicationConstants.FormModes.EDIT_SAVED.equalsIgnoreCase(formMode)) {
                        formControllerAvailable(formController);
                        identityPromptViewModel.requiresIdentityToContinue().observe(this, requiresIdentity -> {
                            if (!requiresIdentity) {
                                if (!allowMovingBackwards) {
                                    // we aren't allowed to jump around the form so attempt to
                                    // go directly to the question we were on last time the
                                    // form was saved.
                                    // TODO: revisit the fallback. If for some reason the index
                                    // wasn't saved, we can now jump around which doesn't seem right.
                                    FormIndex formIndex = SaveFormIndexTask.loadFormIndexFromFile();
                                    if (formIndex != null) {
                                        formController.jumpToIndex(formIndex);
                                        onScreenRefresh();
                                        return;
                                    }
                                }
                                formController.getAuditEventLogger().logEvent(AuditEvent.AuditEventType.FORM_RESUME, true, System.currentTimeMillis());
                                formController.getAuditEventLogger().logEvent(AuditEvent.AuditEventType.HIERARCHY, true, System.currentTimeMillis());
                                startActivityForResult(new Intent(this, FormHierarchyActivity.class), RequestCodes.HIERARCHY_ACTIVITY);
                            }
                        });
                        formSaveViewModel.editingForm();
                    } else {
                        if (ApplicationConstants.FormModes.VIEW_SENT.equalsIgnoreCase(formMode)) {
                            startActivity(new Intent(this, ViewOnlyFormHierarchyActivity.class));
                        }
                        finish();
                    }
                } else {
                    formControllerAvailable(formController);
                    identityPromptViewModel.requiresIdentityToContinue().observe(this, requiresIdentity -> {
                        if (!requiresIdentity) {
                            formController.getAuditEventLogger().logEvent(AuditEvent.AuditEventType.FORM_RESUME, true, System.currentTimeMillis());
                            startFormEntry(formController, warningMsg);
                        }
                    });
                }
            }
        }
    } else {
        Timber.e("FormController is null");
        showLongToast(this, R.string.loading_form_failed);
        finish();
    }
}