DataFormProvider.java

  1. /**
  2.  *
  3.  * Copyright 2003-2007 Jive Software.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.jivesoftware.smackx.xdata.provider;

  20. import org.jivesoftware.smack.provider.ExtensionElementProvider;
  21. import org.jivesoftware.smack.roster.packet.RosterPacket;
  22. import org.jivesoftware.smack.roster.provider.RosterPacketProvider;
  23. import org.jivesoftware.smackx.xdata.FormField;
  24. import org.jivesoftware.smackx.xdata.packet.DataForm;
  25. import org.jivesoftware.smackx.xdatalayout.packet.DataLayout;
  26. import org.jivesoftware.smackx.xdatalayout.provider.DataLayoutProvider;
  27. import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement;
  28. import org.jivesoftware.smackx.xdatavalidation.provider.DataValidationProvider;
  29. import org.xmlpull.v1.XmlPullParser;
  30. import org.xmlpull.v1.XmlPullParserException;

  32. import java.io.IOException;
  33. import java.util.ArrayList;
  34. import java.util.List;

  36. /**
  37.  * The DataFormProvider parses DataForm packets.
  38.  * 
  39.  * @author Gaston Dombiak
  40.  */
  41. public class DataFormProvider extends ExtensionElementProvider<DataForm> {

  43.     @Override
  44.     public DataForm parse(XmlPullParser parser, int initialDepth) throws
  45.                     Exception {
  46.         DataForm.Type dataFormType = DataForm.Type.fromString(parser.getAttributeValue("", "type"));
  47.         DataForm dataForm = new DataForm(dataFormType);
  48.         outerloop: while (true) {
  49.             int eventType = parser.next();
  50.             switch (eventType) {
  51.             case XmlPullParser.START_TAG:
  52.                 String name = parser.getName();
  53.                 String namespace = parser.getNamespace();
  54.                 switch (name) {
  55.                 case "instructions":
  56.                     dataForm.addInstruction(parser.nextText());
  57.                     break;
  58.                 case "title":
  59.                     dataForm.setTitle(parser.nextText());
  60.                     break;
  61.                 case "field":
  62.                     dataForm.addField(parseField(parser));
  63.                     break;
  64.                 case "item":
  65.                     dataForm.addItem(parseItem(parser));
  66.                     break;
  67.                 case "reported":
  68.                     dataForm.setReportedData(parseReported(parser));
  69.                     break;
  70.                 // See XEP-133 Example 32 for a corner case where the data form contains this extension.
  71.                 case RosterPacket.ELEMENT:
  72.                     if (namespace.equals(RosterPacket.NAMESPACE)) {
  73.                         dataForm.addExtensionElement(RosterPacketProvider.INSTANCE.parse(parser));
  74.                     }
  75.                     break;
  76.                 // See XEP-141 Data Forms Layout
  77.                 case DataLayout.ELEMENT:
  78.                     if (namespace.equals(DataLayout.NAMESPACE)) {
  79.                         dataForm.addExtensionElement(DataLayoutProvider.parse(parser));
  80.                     }
  81.                     break;
  82.                 }
  83.                 break;
  84.             case XmlPullParser.END_TAG:
  85.                 if (parser.getDepth() == initialDepth) {
  86.                     break outerloop;
  87.                 }
  88.                 break;
  89.             }
  90.         }
  91.         return dataForm;
  92.     }

  94.     private FormField parseField(XmlPullParser parser) throws XmlPullParserException, IOException {
  95.         final int initialDepth = parser.getDepth();
  96.         final String var = parser.getAttributeValue("", "var");
  97.         final FormField.Type type = FormField.Type.fromString(parser.getAttributeValue("", "type"));

  99.         final FormField formField;
  100.         if (type == FormField.Type.fixed) {
  101.             formField = new FormField();
  102.         } else {
  103.             formField = new FormField(var);
  104.             formField.setType(type);
  105.         }
  106.         formField.setLabel(parser.getAttributeValue("", "label"));

  108.         outerloop: while (true) {
  109.             int eventType = parser.next();
  110.             switch (eventType) {
  111.             case XmlPullParser.START_TAG:
  112.                 String name = parser.getName();
  113.                 String namespace = parser.getNamespace();
  114.                 switch (name) {
  115.                 case "desc":
  116.                     formField.setDescription(parser.nextText());
  117.                     break;
  118.                 case "value":
  119.                     formField.addValue(parser.nextText());
  120.                     break;
  121.                 case "required":
  122.                     formField.setRequired(true);
  123.                     break;
  124.                 case "option":
  125.                     formField.addOption(parseOption(parser));
  126.                     break;
  127.                 // See XEP-122 Data Forms Validation
  128.                 case ValidateElement.ELEMENT:
  129.                     if (namespace.equals(ValidateElement.NAMESPACE)) {
  130.                         formField.setValidateElement(DataValidationProvider.parse(parser));
  131.                     }
  132.                     break;
  133.                 }
  134.             case XmlPullParser.END_TAG:
  135.                 if (parser.getDepth() == initialDepth) {
  136.                     break outerloop;
  137.                 }
  138.                 break;
  139.             }
  140.         }
  141.         return formField;
  142.     }

  144.     private DataForm.Item parseItem(XmlPullParser parser) throws XmlPullParserException, IOException {
  145.         final int initialDepth = parser.getDepth();
  146.         List<FormField> fields = new ArrayList<FormField>();
  147.         outerloop: while (true) {
  148.             int eventType = parser.next();
  149.             switch (eventType) {
  150.             case XmlPullParser.START_TAG:
  151.                 String name = parser.getName();
  152.                 switch (name) {
  153.                 case "field":
  154.                     fields.add(parseField(parser));
  155.                     break;
  156.                 }
  157.                 break;
  158.             case XmlPullParser.END_TAG:
  159.                 if (parser.getDepth() == initialDepth) {
  160.                     break outerloop;
  161.                 }
  162.                 break;
  163.             }
  164.         }
  165.         return new DataForm.Item(fields);
  166.     }

  168.     private DataForm.ReportedData parseReported(XmlPullParser parser) throws XmlPullParserException, IOException {
  169.         final int initialDepth = parser.getDepth();
  170.         List<FormField> fields = new ArrayList<FormField>();
  171.         outerloop: while (true) {
  172.             int eventType = parser.next();
  173.             switch (eventType) {
  174.             case XmlPullParser.START_TAG:
  175.                 String name = parser.getName();
  176.                 switch (name) {
  177.                 case "field":
  178.                     fields.add(parseField(parser));
  179.                     break;
  180.                 }
  181.                 break;
  182.             case XmlPullParser.END_TAG:
  183.                 if (parser.getDepth() == initialDepth) {
  184.                     break outerloop;
  185.                 }
  186.                 break;
  187.             }
  188.         }
  189.         return new DataForm.ReportedData(fields);
  190.     }

  192.     private FormField.Option parseOption(XmlPullParser parser) throws XmlPullParserException, IOException {
  193.         final int initialDepth = parser.getDepth();
  194.         FormField.Option option = null;
  195.         String label = parser.getAttributeValue("", "label");
  196.         outerloop: while (true) {
  197.             int eventType = parser.next();
  198.             switch (eventType) {
  199.             case XmlPullParser.START_TAG:
  200.                 String name = parser.getName();
  201.                 switch (name) {
  202.                 case "value":
  203.                     option = new FormField.Option(label, parser.nextText());
  204.                     break;
  205.                 }
  206.                 break;
  207.             case XmlPullParser.END_TAG:
  208.                 if (parser.getDepth() == initialDepth) {
  209.                     break outerloop;
  210.                 }
  211.                 break;
  212.             }
  213.         }
  214.         return option;
  215.     }
  216. }
Created with JaCoCo 0.7.4.201502262128