1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-08 12:01:09 +01:00

Re-work data form API

Apply builder pattern to form fields and replace getVariable() with
getFieldName(). Refer to the field name as "field name" instead of
"variable" everyone, just as XEP-0004 does.

Improve the high-level form API: introduce FilledForm and FillableForm
which perform stronger validation and consistency checks.

Also add FormFieldRegistry to enable processing of 'submit' forms
where the form field types are omitted.

Smack also now does omit the form field type declaration on 'submit'
type forms, as it is allowed by XEP-0004.
This commit is contained in:
Florian Schmaus 2020-05-13 20:14:41 +02:00
parent 3270c113c5
commit 77e26fc575
97 changed files with 3809 additions and 2427 deletions

View file

@ -36,6 +36,8 @@ import org.jivesoftware.smackx.caps.cache.SimpleDirectoryPersistentCache;
import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
import org.jivesoftware.smackx.disco.packet.DiscoverInfoBuilder;
import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.TextMultiFormField;
import org.jivesoftware.smackx.xdata.TextSingleFormField;
import org.jivesoftware.smackx.xdata.packet.DataForm;
import org.junit.jupiter.api.Test;
@ -97,6 +99,49 @@ public class EntityCapsManagerTest extends SmackTestSuite {
assertEquals(di.toXML().toString(), restored_di.toXML().toString());
}
private static DataForm createSampleSoftwareInfoDataForm() {
DataForm.Builder df = DataForm.builder(DataForm.Type.result);
{
TextSingleFormField.Builder ff = FormField.builder("os");
ff.setValue("Mac");
df.addField(ff.build());
}
{
TextSingleFormField.Builder ff = FormField.hiddenBuilder("FORM_TYPE");
ff.setValue("urn:xmpp:dataforms:softwareinfo");
df.addField(ff.build());
}
{
TextMultiFormField.Builder ff = FormField.textMultiBuilder("ip_version");
ff.addValue("ipv4");
ff.addValue("ipv6");
df.addField(ff.build());
}
{
TextSingleFormField.Builder ff = FormField.builder("os_version");
ff.setValue("10.5.1");
df.addField(ff.build());
}
{
TextSingleFormField.Builder ff = FormField.builder("software");
ff.setValue("Psi");
df.addField(ff.build());
}
{
TextSingleFormField.Builder ff = FormField.builder("software_version");
ff.setValue("0.11");
df.addField(ff.build());
}
return df.build();
}
private static DiscoverInfo createComplexSamplePacket() throws XmppStringprepException {
DiscoverInfoBuilder di = DiscoverInfo.builder("disco1");
di.from(JidCreate.from("benvolio@capulet.lit/230193"));
@ -115,35 +160,8 @@ public class EntityCapsManagerTest extends SmackTestSuite {
di.addFeature("http://jabber.org/protocol/muc");
di.addFeature("http://jabber.org/protocol/disco#info");
DataForm df = new DataForm(DataForm.Type.result);
FormField.Builder ff = FormField.builder("os");
ff.addValue("Mac");
df.addField(ff.build());
ff = FormField.builder("FORM_TYPE");
ff.setType(FormField.Type.hidden);
ff.addValue("urn:xmpp:dataforms:softwareinfo");
df.addField(ff.build());
ff = FormField.builder("ip_version");
ff.addValue("ipv4");
ff.addValue("ipv6");
df.addField(ff.build());
ff = FormField.builder("os_version");
ff.addValue("10.5.1");
df.addField(ff.build());
ff = FormField.builder("software");
ff.addValue("Psi");
df.addField(ff.build());
ff = FormField.builder("software_version");
ff.addValue("0.11");
df.addField(ff.build());
di.addExtension(df);
DataForm softwareInfoDataForm = createSampleSoftwareInfoDataForm();
di.addExtension(softwareInfoDataForm);
return di.build();
}
@ -171,50 +189,8 @@ public class EntityCapsManagerTest extends SmackTestSuite {
// Failure 2: Duplicate features
di.addFeature("http://jabber.org/protocol/disco#info");
DataForm df = new DataForm(DataForm.Type.result);
FormField.Builder ff = FormField.builder("os");
ff.addValue("Mac");
df.addField(ff.build());
ff = FormField.builder("FORM_TYPE");
ff.setType(FormField.Type.hidden);
ff.addValue("urn:xmpp:dataforms:softwareinfo");
df.addField(ff.build());
ff = FormField.builder("ip_version");
ff.addValue("ipv4");
ff.addValue("ipv6");
df.addField(ff.build());
ff = FormField.builder("os_version");
ff.addValue("10.5.1");
df.addField(ff.build());
ff = FormField.builder("software");
ff.addValue("Psi");
df.addField(ff.build());
ff = FormField.builder("software_version");
ff.addValue("0.11");
df.addField(ff.build());
di.addExtension(df);
// Failure 3: Another service discovery information form with the same
// FORM_TYPE
df = new DataForm(DataForm.Type.result);
ff = FormField.builder("FORM_TYPE");
ff.setType(FormField.Type.hidden);
ff.addValue("urn:xmpp:dataforms:softwareinfo");
df.addField(ff.build());
ff = FormField.builder("software");
ff.addValue("smack");
df.addField(ff.build());
di.addExtension(df);
DataForm softwareInfoDataForm = createSampleSoftwareInfoDataForm();
di.addExtension(softwareInfoDataForm);
DiscoverInfo discoverInfo = di.buildWithoutValidiation();
return discoverInfo;

View file

@ -21,6 +21,7 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.TextSingleFormField;
import org.jivesoftware.smackx.xdata.packet.DataForm;
import org.junit.jupiter.api.Test;
@ -28,7 +29,7 @@ import org.junit.jupiter.api.Test;
public class RoomInfoTest {
@Test
public void validateRoomWithEmptyForm() {
DataForm dataForm = new DataForm(DataForm.Type.result);
DataForm dataForm = DataForm.builder(DataForm.Type.result).build();
DiscoverInfo discoInfo = DiscoverInfo.builder("disco1")
.addExtension(dataForm)
@ -41,22 +42,22 @@ public class RoomInfoTest {
@Test
public void validateRoomWithForm() {
DataForm dataForm = new DataForm(DataForm.Type.result);
DataForm.Builder dataForm = DataForm.builder(DataForm.Type.result);
FormField.Builder desc = FormField.builder("muc#roominfo_description");
desc.addValue("The place for all good witches!");
TextSingleFormField.Builder desc = FormField.builder("muc#roominfo_description");
desc.setValue("The place for all good witches!");
dataForm.addField(desc.build());
FormField.Builder subject = FormField.builder("muc#roominfo_subject");
subject.addValue("Spells");
TextSingleFormField.Builder subject = FormField.builder("muc#roominfo_subject");
subject.setValue("Spells");
dataForm.addField(subject.build());
FormField.Builder occupants = FormField.builder("muc#roominfo_occupants");
occupants.addValue("3");
TextSingleFormField.Builder occupants = FormField.builder("muc#roominfo_occupants");
occupants.setValue("3");
dataForm.addField(occupants.build());
DiscoverInfo discoInfo = DiscoverInfo.builder("disco1")
.addExtension(dataForm)
.addExtension(dataForm.build())
.build();
RoomInfo roomInfo = new RoomInfo(discoInfo);
assertEquals("The place for all good witches!", roomInfo.getDescription());

View file

@ -37,7 +37,6 @@ import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
import org.jivesoftware.smackx.disco.packet.DiscoverInfo.Identity;
import org.jivesoftware.smackx.disco.packet.DiscoverInfoBuilder;
import org.jivesoftware.smackx.pubsub.packet.PubSub;
import org.jivesoftware.smackx.xdata.packet.DataForm;
import org.junit.jupiter.api.Test;
@ -47,12 +46,6 @@ import org.junit.jupiter.api.Test;
*
*/
public class ConfigureFormTest extends SmackTestSuite {
@Test
public void checkChildrenAssocPolicy() {
ConfigureForm form = new ConfigureForm(DataForm.Type.submit);
form.setChildrenAssociationPolicy(ChildrenAssociationPolicy.owners);
assertEquals(ChildrenAssociationPolicy.owners, form.getChildrenAssociationPolicy());
}
@Test
public void getConfigFormWithInsufficientPrivileges() throws XMPPException, SmackException, IOException, InterruptedException {
@ -107,13 +100,4 @@ public class ConfigureFormTest extends SmackTestSuite {
});
}
@Test
public void checkNotificationType() {
ConfigureForm form = new ConfigureForm(DataForm.Type.submit);
form.setNotificationType(NotificationType.normal);
assertEquals(NotificationType.normal, form.getNotificationType());
form.setNotificationType(NotificationType.headline);
assertEquals(NotificationType.headline, form.getNotificationType());
}
}

View file

@ -0,0 +1,38 @@
/**
*
* Copyright 2020 Florian Schmaus.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smackx.xdata;
import static org.jivesoftware.smack.test.util.XmlUnitUtils.assertXmlSimilar;
import org.junit.jupiter.api.Test;
import org.jxmpp.jid.JidTestUtil;
class FormFieldTest {
@Test
public void testJidMultiToXml() {
JidMultiFormField jidMultiFormField = FormField.jidMultiBuilder("myfield")
.addValue(JidTestUtil.BARE_JID_1)
.addValue(JidTestUtil.BARE_JID_2)
.build();
String expectedXml = "<field xmlns='jabber:x:data' var='myfield' type='jid-multi'><value>one@exampleone.org</value><value>one@exampletwo.org</value></field>";
CharSequence xml = jidMultiFormField.toXML();
assertXmlSimilar(expectedXml, xml);
}
}

View file

@ -43,43 +43,42 @@ import org.junit.jupiter.api.Test;
*
*/
public class DataFormTest extends SmackTestSuite {
private static final String TEST_OUTPUT_1 = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field var='testField1'/></x>";
private static final String TEST_OUTPUT_2 = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field var='testField1'/><page xmlns='http://jabber.org/protocol/xdata-layout' label='Label'><fieldref var='testField1'/><section label='section Label'><text>SectionText</text></section><text>PageText</text></page></x>";
private static final String TEST_OUTPUT_3 = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field var='testField1'><validate xmlns='http://jabber.org/protocol/xdata-validate' datatype='xs:integer'><range min='1111' max='9999'/></validate></field></x>";
private static final String TEST_OUTPUT_1 = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field var='testField1'/></x>";
private static final String TEST_OUTPUT_2 = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field var='testField1'/><page xmlns='http://jabber.org/protocol/xdata-layout' label='Label'><fieldref var='testField1'/><section label='section Label'><text>SectionText</text></section><text>PageText</text></page></x>";
private static final String TEST_OUTPUT_3 = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field var='testField1'><validate xmlns='http://jabber.org/protocol/xdata-validate' datatype='xs:integer'><range min='1111' max='9999'/></validate></field></x>";
private static final DataFormProvider pr = new DataFormProvider();
@Test
public void test() throws Exception {
// Build a Form.
DataForm df = new DataForm(DataForm.Type.submit);
DataForm.Builder df = DataForm.builder(DataForm.Type.form);
String instruction = "InstructionTest1";
df.addInstruction(instruction);
FormField field = FormField.builder("testField1").build();
df.addField(field);
assertNotNull(df.toXML());
String output = df.toXML().toString();
DataForm dataForm = df.build();
String output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_1, output);
XmlPullParser parser = PacketParserUtils.getParserFor(output);
df = pr.parse(parser);
dataForm = pr.parse(parser);
assertNotNull(df);
assertNotNull(df.getFields());
assertEquals(1 , df.getFields().size());
assertEquals(1 , df.getInstructions().size());
assertNotNull(dataForm);
assertNotNull(dataForm.getFields());
assertEquals(1 , dataForm.getFields().size());
assertEquals(1 , dataForm.getInstructions().size());
assertNotNull(df.toXML());
output = df.toXML().toString();
output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_1, output);
}
@Test
public void testLayout() throws Exception {
// Build a Form.
DataForm df = new DataForm(DataForm.Type.submit);
DataForm.Builder df = DataForm.builder(DataForm.Type.form);
String instruction = "InstructionTest1";
df.addInstruction(instruction);
FormField field = FormField.builder("testField1").build();
@ -95,67 +94,62 @@ public class DataFormTest extends SmackTestSuite {
df.addExtensionElement(layout);
assertNotNull(df.toXML());
String output = df.toXML().toString();
DataForm dataForm = df.build();
String output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_2, output);
XmlPullParser parser = PacketParserUtils.getParserFor(output);
df = pr.parse(parser);
dataForm = pr.parse(parser);
assertNotNull(df);
assertNotNull(df.getExtensionElements());
assertEquals(1 , df.getExtensionElements().size());
Element element = df.getExtensionElements().get(0);
assertNotNull(dataForm.getExtensionElements());
assertEquals(1 , dataForm.getExtensionElements().size());
Element element = dataForm.getExtensionElements().get(0);
assertNotNull(element);
layout = (DataLayout) element;
assertEquals(3 , layout.getPageLayout().size());
assertNotNull(df.toXML());
output = df.toXML().toString();
output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_2, output);
}
@Test
public void testValidation() throws Exception {
// Build a Form.
DataForm df = new DataForm(DataForm.Type.submit);
DataForm.Builder df = DataForm.builder(DataForm.Type.form);
String instruction = "InstructionTest1";
df.addInstruction(instruction);
FormField.Builder fieldBuilder = FormField.builder("testField1");
FormField.Builder<?, ?> fieldBuilder = FormField.builder("testField1");
ValidateElement dv = new RangeValidateElement("xs:integer", "1111", "9999");
fieldBuilder.addFormFieldChildElement(dv);
df.addField(fieldBuilder.build());
assertNotNull(df.toXML());
String output = df.toXML().toString();
DataForm dataForm = df.build();
String output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_3, output);
XmlPullParser parser = PacketParserUtils.getParserFor(output);
df = pr.parse(parser);
dataForm = pr.parse(parser);
assertNotNull(df);
assertNotNull(df.getFields());
assertEquals(1 , df.getFields().size());
Element element = ValidateElement.from(df.getFields().get(0));
assertNotNull(dataForm.getFields());
assertEquals(1 , dataForm.getFields().size());
Element element = ValidateElement.from(dataForm.getFields().get(0));
assertNotNull(element);
dv = (ValidateElement) element;
assertEquals("xs:integer" , dv.getDatatype());
assertNotNull(df.toXML());
output = df.toXML().toString();
output = dataForm.toXML().toString();
assertEquals(TEST_OUTPUT_3, output);
}
@Test
public void testFixedField() throws Exception {
final String formWithFixedField = "<x xmlns='jabber:x:data' type='submit'><instructions>InstructionTest1</instructions><field type='fixed'></field></x>";
final String formWithFixedField = "<x xmlns='jabber:x:data' type='form'><instructions>InstructionTest1</instructions><field type='fixed'><value>Fixed field value</value></field></x>";
DataForm df = pr.parse(PacketParserUtils.getParserFor(formWithFixedField));
assertEquals(Type.fixed, df.getFields().get(0).getType());
}

View file

@ -20,6 +20,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.JidSingleFormField;
import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement.BasicValidateElement;
import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement.ListRange;
import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement.OpenValidateElement;
@ -37,8 +38,7 @@ public class DataValidationHelperTest {
@Test
public void testCheckConsistencyFormFieldBasicValidateElement() {
FormField.Builder field = FormField.builder("var")
.setType(FormField.Type.jid_single);
JidSingleFormField.Builder field = FormField.jidSingleBuilder("var");
BasicValidateElement element = new BasicValidateElement(null);
ValidationConsistencyException vce = assertThrows(ValidationConsistencyException.class,
() -> element.checkConsistency(field));
@ -52,15 +52,14 @@ public class DataValidationHelperTest {
vce = assertThrows(ValidationConsistencyException.class, () -> element.checkConsistency(field));
assertEquals("Field type is not of type 'list-multi' while a 'list-range' is defined.", vce.getMessage());
FormField.Builder fieldListMulti = field.setType(FormField.Type.list_multi);
FormField.Builder<?, ?> fieldListMulti = FormField.listMultiBuilder("var");
element.checkConsistency(fieldListMulti);
}
@Test
public void testCheckConsistencyFormFieldOpenValidateElement() {
FormField.Builder field = FormField.builder("var")
.setType(FormField.Type.hidden);
FormField.Builder<?, ?> field = FormField.hiddenBuilder("var");
OpenValidateElement element = new OpenValidateElement(null);
ValidationConsistencyException e = assertThrows(ValidationConsistencyException.class,
() -> element.checkConsistency(field));
@ -69,8 +68,7 @@ public class DataValidationHelperTest {
@Test
public void testCheckConsistencyFormFieldRangeValidateElement() {
FormField.Builder field = FormField.builder("var")
.setType(FormField.Type.text_multi);
FormField.Builder<?, ?> field = FormField.textMultiBuilder("var");
RangeValidateElement element = new RangeValidateElement("xs:integer", null, "99");
ValidationConsistencyException e = assertThrows(ValidationConsistencyException.class,
() -> element.checkConsistency(field));
@ -79,8 +77,7 @@ public class DataValidationHelperTest {
@Test
public void testCheckConsistencyFormFieldRegexValidateElement() {
FormField.Builder field = FormField.builder("var")
.setType(FormField.Type.list_multi);
FormField.Builder<?, ?> field = FormField.listMultiBuilder("var");
RegexValidateElement element = new RegexValidateElement(null, ".*");
ValidationConsistencyException e = assertThrows(ValidationConsistencyException.class,
() -> element.checkConsistency(field));