Merge pull request #7141 from grzesiek2010/COLLECT-7138_1

Fix reading form metadata in forms containing multiple meta sections

Author: seadowg

collect_app/src/main/java/org/odk/collect/android/javarosawrapper/InstanceMetadata.java

@@ -0,0 +1,12 @@
+package org.odk.collect.android.javarosawrapper
+
+import org.odk.collect.android.formentry.audit.AuditConfig
+import org.odk.collect.android.utilities.FormNameUtils
+
+data class InstanceMetadata(
+    @JvmField val instanceId: String?,
+    private val rawInstanceName: String?,
+    @JvmField val auditConfig: AuditConfig?
+) {
+    @JvmField val instanceName: String? = FormNameUtils.normalizeFormName(rawInstanceName, false)
+}

collect_app/src/main/java/org/odk/collect/android/javarosawrapper/InstanceMetadata.kt

@@ -1010,76 +1010,41 @@ public ByteArrayPayload getSubmissionXml() throws IOException {
                 getSubmissionDataReference());
     }
 
-    /**
-     * Traverse the submission looking for the first matching tag in depth-first order.
-     */
-    private TreeElement findDepthFirst(TreeElement parent, String name) {
-        int len = parent.getNumChildren();
-        for (int i = 0; i < len; ++i) {
-            TreeElement e = parent.getChildAt(i);
-            if (name.equals(e.getName())) {
-                return e;
-            } else if (e.getNumChildren() != 0) {
-                TreeElement v = findDepthFirst(e, name);
-                if (v != null) {
-                    return v;
-                }
-            }
-        }
-        return null;
-    }
-
     public InstanceMetadata getSubmissionMetadata() {
         FormDef formDef = formEntryController.getModel().getForm();
         TreeElement rootElement = formDef.getInstance().getRoot();
-
-        TreeElement trueSubmissionElement;
-        // Determine the information about the submission...
-        SubmissionProfile p = formDef.getSubmissionProfile();
-        if (p == null || p.getRef() == null) {
-            trueSubmissionElement = rootElement;
-        } else {
-            IDataReference ref = p.getRef();
-            trueSubmissionElement = formDef.getInstance().resolveReference(ref);
-            // resolveReference returns null if the reference is to the root element...
-            if (trueSubmissionElement == null) {
-                trueSubmissionElement = rootElement;
-            }
-        }
-
-        // and find the depth-first meta block in this...
-        TreeElement e = findDepthFirst(trueSubmissionElement, "meta");
+        TreeElement meta = rootElement.getFirstChild("meta");
 
         String instanceId = null;
         String instanceName = null;
         AuditConfig auditConfig = null;
 
-        if (e != null) {
-            List<TreeElement> v;
+        if (meta != null) {
+            List<TreeElement> metaElements;
 
             // instance id...
-            v = e.getChildrenWithName(INSTANCE_ID);
-            if (v.size() == 1) {
-                IAnswerData sa = v.get(0).getValue();
+            metaElements = meta.getChildrenWithName(INSTANCE_ID);
+            if (metaElements.size() == 1) {
+                IAnswerData sa = metaElements.get(0).getValue();
                 if (sa != null) {
                     instanceId = sa.getDisplayText();
                 }
             }
 
             // instance name...
-            v = e.getChildrenWithName(INSTANCE_NAME);
-            if (v.size() == 1) {
-                IAnswerData sa = v.get(0).getValue();
+            metaElements = meta.getChildrenWithName(INSTANCE_NAME);
+            if (metaElements.size() == 1) {
+                IAnswerData sa = metaElements.get(0).getValue();
                 if (sa != null) {
                     instanceName = sa.getDisplayText();
                 }
             }
 
             // timing element...
-            v = e.getChildrenWithName(AUDIT);
-            if (v.size() == 1) {
+            metaElements = meta.getChildrenWithName(AUDIT);
+            if (metaElements.size() == 1) {
 
-                TreeElement auditElement = v.get(0);
+                TreeElement auditElement = metaElements.get(0);
 
                 String locationPriority = auditElement.getBindAttributeValue(XML_OPENDATAKIT_NAMESPACE, "location-priority");
                 String locationMinInterval = auditElement.getBindAttributeValue(XML_OPENDATAKIT_NAMESPACE, "location-min-interval");

collect_app/src/main/java/org/odk/collect/android/javarosawrapper/JavaRosaFormController.java

@@ -121,6 +121,11 @@ public void whenInstanceFileAndAuditConfigNull_getAuditEventLogger_isNotNull() t
         assertThat(formController.getAuditEventLogger(), notNullValue());
     }
 
+    @Test
+    public void getSubmissionMetadata_usesTopLevelMeta_whenMultipleMetaSectionsExist() throws Exception {
+        FormController formController = createFormController(MULTIPLE_META_SECTIONS);
+        assertThat(formController.getSubmissionMetadata().instanceName, is(notNullValue()));
+    }
 
     //region indexIsInFieldList
     @Test
@@ -149,6 +154,7 @@ private FormController createFormController(String xform) throws IOException, XF
         ByteArrayInputStream inputStream = new ByteArrayInputStream(xform.getBytes());
         final FormEntryModel fem = new FormEntryModel(XFormUtils.getFormFromInputStream(inputStream));
         final FormEntryController formEntryController = new FormEntryController(fem);
+        formEntryController.getModel().getForm().initialize(true, null);
         return new JavaRosaFormController(Files.createTempDir(), formEntryController, File.createTempFile("instance", ""));
     }
 
@@ -293,4 +299,40 @@ private FormController createFormController(String xform) throws IOException, XF
             "        </group>\n" +
             "    </h:body>\n" +
             "</h:html>\n";
+
+    private static final String MULTIPLE_META_SECTIONS = "<?xml version=\"1.0\"?>\n" +
+            "<h:html xmlns=\"http://www.w3.org/2002/xforms\" xmlns:h=\"http://www.w3.org/1999/xhtml\" xmlns:entities=\"http://www.opendatakit.org/xforms/entities\" xmlns:jr=\"http://openrosa.org/javarosa\">\n" +
+            "    <h:head>\n" +
+            "        <h:title>Multiple meta sections</h:title>\n" +
+            "        <model entities:entities-version=\"2024.1.0\">\n" +
+            "            <instance>\n" +
+            "                <data id=\"multiple-meta-sections\">\n" +
+            "                    <group>\n" +
+            "                        <question>xxx</question>\n" +
+            "                        <meta>\n" +
+            "                           <entity dataset=\"entity_test\" create=\"1\" id=\"\">\n" +
+            "                               <label/>\n" +
+            "                           </entity>\n" +
+            "                        </meta>\n" +
+            "                    </group>\n" +
+            "                    <meta>\n" +
+            "                       <instanceName/>\n" +
+            "                   </meta>\n" +
+            "                </data>\n" +
+            "            </instance>\n" +
+            "            <bind nodeset=\"/data/group/question\" type=\"int\"/>\n" +
+            "            <bind nodeset=\"/data/group/meta/entity/@id\" readonly=\"true()\" type=\"string\"/>\n" +
+            "            <setvalue ref=\"/data/group/meta/entity/@id\" event=\"odk-instance-first-load\" value=\"uuid()\"/>\n" +
+            "            <bind nodeset=\"/data/group/meta/entity/label\" calculate=\"/data/group/question\" readonly=\"true()\" type=\"string\"/>\n" +
+            "            <bind nodeset=\"/data/meta/instanceName\" type=\"string\" calculate=\"uuid()\"/>\n" +
+            "        </model>\n" +
+            "    </h:head>\n" +
+            "    <h:body>\n" +
+            "        <group ref=\"/data/group\">\n" +
+            "          <input ref=\"/data/group/question\">\n" +
+            "            <label>Question</label>\n" +
+            "          </input>\n" +
+            "        </group>\n" +
+            "    </h:body>\n" +
+            "</h:html>\n";
 }