2004-03-29 23:29:55 +02:00
|
|
|
/**
|
2004-11-03 00:37:00 +01:00
|
|
|
*
|
2007-02-12 01:59:05 +01:00
|
|
|
* Copyright 2003-2007 Jive Software.
|
2004-11-03 00:37:00 +01:00
|
|
|
*
|
2014-02-17 18:57:38 +01:00
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
2004-11-03 00:37:00 +01:00
|
|
|
* 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.
|
|
|
|
*/
|
2004-03-29 23:29:55 +02:00
|
|
|
|
2014-02-15 11:35:08 +01:00
|
|
|
package org.jivesoftware.smackx.xdata.provider;
|
2004-03-29 23:29:55 +02:00
|
|
|
|
2017-06-14 17:12:43 +02:00
|
|
|
import java.io.IOException;
|
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.List;
|
2019-06-10 16:58:38 +02:00
|
|
|
import java.util.logging.Logger;
|
|
|
|
|
|
|
|
import javax.xml.namespace.QName;
|
2017-06-14 17:12:43 +02:00
|
|
|
|
2019-02-15 23:21:30 +01:00
|
|
|
import org.jivesoftware.smack.packet.XmlEnvironment;
|
2019-02-10 19:01:47 +01:00
|
|
|
import org.jivesoftware.smack.parsing.SmackParsingException;
|
2015-02-26 18:41:17 +01:00
|
|
|
import org.jivesoftware.smack.provider.ExtensionElementProvider;
|
2015-01-22 13:53:50 +01:00
|
|
|
import org.jivesoftware.smack.roster.packet.RosterPacket;
|
|
|
|
import org.jivesoftware.smack.roster.provider.RosterPacketProvider;
|
2019-06-10 16:58:38 +02:00
|
|
|
import org.jivesoftware.smack.util.StringUtils;
|
2019-05-06 22:06:13 +02:00
|
|
|
import org.jivesoftware.smack.xml.XmlPullParser;
|
|
|
|
import org.jivesoftware.smack.xml.XmlPullParserException;
|
2017-06-14 17:12:43 +02:00
|
|
|
|
2014-02-15 11:35:08 +01:00
|
|
|
import org.jivesoftware.smackx.xdata.FormField;
|
2019-06-10 16:58:38 +02:00
|
|
|
import org.jivesoftware.smackx.xdata.FormFieldChildElement;
|
2014-02-15 11:35:08 +01:00
|
|
|
import org.jivesoftware.smackx.xdata.packet.DataForm;
|
2014-11-19 23:51:53 +01:00
|
|
|
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout;
|
|
|
|
import org.jivesoftware.smackx.xdatalayout.provider.DataLayoutProvider;
|
2017-06-14 17:12:43 +02:00
|
|
|
|
2004-03-29 23:29:55 +02:00
|
|
|
/**
|
|
|
|
* The DataFormProvider parses DataForm packets.
|
2018-05-09 23:06:12 +02:00
|
|
|
*
|
2004-03-29 23:29:55 +02:00
|
|
|
* @author Gaston Dombiak
|
|
|
|
*/
|
2015-02-26 18:41:17 +01:00
|
|
|
public class DataFormProvider extends ExtensionElementProvider<DataForm> {
|
2004-03-29 23:29:55 +02:00
|
|
|
|
2019-06-10 16:58:38 +02:00
|
|
|
private static final Logger LOGGER = Logger.getLogger(DataFormProvider.class.getName());
|
|
|
|
|
2016-07-23 15:45:45 +02:00
|
|
|
public static final DataFormProvider INSTANCE = new DataFormProvider();
|
|
|
|
|
2014-10-07 21:15:20 +02:00
|
|
|
@Override
|
2019-02-15 23:21:30 +01:00
|
|
|
public DataForm parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
|
2015-01-10 20:10:46 +01:00
|
|
|
DataForm.Type dataFormType = DataForm.Type.fromString(parser.getAttributeValue("", "type"));
|
|
|
|
DataForm dataForm = new DataForm(dataFormType);
|
2014-11-21 09:38:37 +01:00
|
|
|
outerloop: while (true) {
|
2019-05-06 22:06:13 +02:00
|
|
|
XmlPullParser.Event eventType = parser.next();
|
2014-11-21 09:38:37 +01:00
|
|
|
switch (eventType) {
|
2019-05-06 22:06:13 +02:00
|
|
|
case START_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
String name = parser.getName();
|
|
|
|
String namespace = parser.getNamespace();
|
2019-06-10 16:58:38 +02:00
|
|
|
XmlEnvironment elementXmlEnvironment = XmlEnvironment.from(parser, xmlEnvironment);
|
2014-11-21 09:38:37 +01:00
|
|
|
switch (name) {
|
|
|
|
case "instructions":
|
2004-04-26 04:33:06 +02:00
|
|
|
dataForm.addInstruction(parser.nextText());
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
|
|
|
case "title":
|
2004-03-29 23:29:55 +02:00
|
|
|
dataForm.setTitle(parser.nextText());
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
|
|
|
case "field":
|
2019-06-10 16:58:38 +02:00
|
|
|
FormField formField = parseField(parser, elementXmlEnvironment);
|
|
|
|
dataForm.addField(formField);
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
|
|
|
case "item":
|
2019-06-10 16:58:38 +02:00
|
|
|
DataForm.Item item = parseItem(parser, elementXmlEnvironment);
|
|
|
|
dataForm.addItem(item);
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
|
|
|
case "reported":
|
2019-06-10 16:58:38 +02:00
|
|
|
DataForm.ReportedData reported = parseReported(parser, elementXmlEnvironment);
|
|
|
|
dataForm.setReportedData(reported);
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2014-09-12 13:43:04 +02:00
|
|
|
// See XEP-133 Example 32 for a corner case where the data form contains this extension.
|
2014-11-21 09:38:37 +01:00
|
|
|
case RosterPacket.ELEMENT:
|
|
|
|
if (namespace.equals(RosterPacket.NAMESPACE)) {
|
|
|
|
dataForm.addExtensionElement(RosterPacketProvider.INSTANCE.parse(parser));
|
|
|
|
}
|
|
|
|
break;
|
2014-11-19 23:51:53 +01:00
|
|
|
// See XEP-141 Data Forms Layout
|
2014-11-21 09:38:37 +01:00
|
|
|
case DataLayout.ELEMENT:
|
|
|
|
if (namespace.equals(DataLayout.NAMESPACE)) {
|
|
|
|
dataForm.addExtensionElement(DataLayoutProvider.parse(parser));
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
break;
|
2019-05-06 22:06:13 +02:00
|
|
|
case END_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
if (parser.getDepth() == initialDepth) {
|
|
|
|
break outerloop;
|
|
|
|
}
|
|
|
|
break;
|
2019-05-06 22:06:13 +02:00
|
|
|
default:
|
|
|
|
// Catch all for incomplete switch (MissingCasesInEnumSwitch) statement.
|
|
|
|
break;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return dataForm;
|
|
|
|
}
|
|
|
|
|
2019-06-10 16:58:38 +02:00
|
|
|
private static FormField parseField(XmlPullParser parser, XmlEnvironment xmlEnvironment)
|
|
|
|
throws XmlPullParserException, IOException, SmackParsingException {
|
2014-11-21 09:38:37 +01:00
|
|
|
final int initialDepth = parser.getDepth();
|
2019-06-10 16:58:38 +02:00
|
|
|
|
2015-01-25 15:45:56 +01:00
|
|
|
final String var = parser.getAttributeValue("", "var");
|
|
|
|
final FormField.Type type = FormField.Type.fromString(parser.getAttributeValue("", "type"));
|
|
|
|
|
2019-06-10 16:58:38 +02:00
|
|
|
final FormField.Builder builder = FormField.builder();
|
|
|
|
builder.setType(type);
|
|
|
|
if (type != FormField.Type.fixed) {
|
|
|
|
builder.setVariable(var);
|
|
|
|
}
|
|
|
|
String label = parser.getAttributeValue("", "label");
|
|
|
|
if (StringUtils.isNotEmpty(label)) {
|
|
|
|
builder.setLabel(label);
|
2014-12-27 20:47:57 +01:00
|
|
|
}
|
2015-01-25 15:45:56 +01:00
|
|
|
|
2014-11-21 09:38:37 +01:00
|
|
|
outerloop: while (true) {
|
2019-05-06 22:06:13 +02:00
|
|
|
XmlPullParser.Event eventType = parser.next();
|
2014-11-21 09:38:37 +01:00
|
|
|
switch (eventType) {
|
2019-05-06 22:06:13 +02:00
|
|
|
case START_ELEMENT:
|
2019-06-10 16:58:38 +02:00
|
|
|
QName qname = parser.getQName();
|
|
|
|
FormFieldChildElementProvider<?> provider = FormFieldChildElementProviderManager.getFormFieldChildElementProvider(
|
|
|
|
qname);
|
|
|
|
if (provider != null) {
|
|
|
|
FormFieldChildElement formFieldChildElement = provider.parse(parser, XmlEnvironment.from(parser, xmlEnvironment));
|
|
|
|
builder.addFormFieldChildElement(formFieldChildElement);
|
|
|
|
} else {
|
|
|
|
LOGGER.warning("Unknown form field child element " + qname + " ignored");
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
2015-03-23 09:27:15 +01:00
|
|
|
break;
|
2019-05-06 22:06:13 +02:00
|
|
|
case END_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
if (parser.getDepth() == initialDepth) {
|
|
|
|
break outerloop;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2019-05-06 22:06:13 +02:00
|
|
|
default:
|
|
|
|
// Catch all for incomplete switch (MissingCasesInEnumSwitch) statement.
|
|
|
|
break;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
|
|
|
}
|
2019-06-10 16:58:38 +02:00
|
|
|
|
|
|
|
return builder.build();
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
|
|
|
|
2019-06-10 16:58:38 +02:00
|
|
|
private static DataForm.Item parseItem(XmlPullParser parser, XmlEnvironment xmlEnvironment)
|
|
|
|
throws XmlPullParserException, IOException, SmackParsingException {
|
2014-11-21 09:38:37 +01:00
|
|
|
final int initialDepth = parser.getDepth();
|
2017-12-13 23:10:11 +01:00
|
|
|
List<FormField> fields = new ArrayList<>();
|
2014-11-21 09:38:37 +01:00
|
|
|
outerloop: while (true) {
|
2019-06-10 16:58:38 +02:00
|
|
|
XmlPullParser.TagEvent eventType = parser.nextTag();
|
2014-11-21 09:38:37 +01:00
|
|
|
switch (eventType) {
|
2019-05-06 22:06:13 +02:00
|
|
|
case START_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
String name = parser.getName();
|
|
|
|
switch (name) {
|
|
|
|
case "field":
|
2019-06-10 16:58:38 +02:00
|
|
|
FormField field = parseField(parser, XmlEnvironment.from(parser, xmlEnvironment));
|
|
|
|
fields.add(field);
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2019-05-06 22:06:13 +02:00
|
|
|
case END_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
if (parser.getDepth() == initialDepth) {
|
|
|
|
break outerloop;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return new DataForm.Item(fields);
|
|
|
|
}
|
|
|
|
|
2019-06-10 16:58:38 +02:00
|
|
|
private static DataForm.ReportedData parseReported(XmlPullParser parser, XmlEnvironment xmlEnvironment)
|
|
|
|
throws XmlPullParserException, IOException, SmackParsingException {
|
2014-11-21 09:38:37 +01:00
|
|
|
final int initialDepth = parser.getDepth();
|
2017-12-13 23:10:11 +01:00
|
|
|
List<FormField> fields = new ArrayList<>();
|
2014-11-21 09:38:37 +01:00
|
|
|
outerloop: while (true) {
|
2019-06-10 16:58:38 +02:00
|
|
|
XmlPullParser.TagEvent eventType = parser.nextTag();
|
2014-11-21 09:38:37 +01:00
|
|
|
switch (eventType) {
|
2019-05-06 22:06:13 +02:00
|
|
|
case START_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
String name = parser.getName();
|
|
|
|
switch (name) {
|
|
|
|
case "field":
|
2019-06-10 16:58:38 +02:00
|
|
|
FormField field = parseField(parser, XmlEnvironment.from(parser, xmlEnvironment));
|
|
|
|
fields.add(field);
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2019-05-06 22:06:13 +02:00
|
|
|
case END_ELEMENT:
|
2014-11-21 09:38:37 +01:00
|
|
|
if (parser.getDepth() == initialDepth) {
|
|
|
|
break outerloop;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
2014-11-21 09:38:37 +01:00
|
|
|
break;
|
2004-03-29 23:29:55 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return new DataForm.ReportedData(fields);
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|