381 lines
13 KiB
Java
381 lines
13 KiB
Java
/**
|
|
*
|
|
* Copyright © 2014-2019 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.smack.util;
|
|
|
|
import java.io.IOException;
|
|
import java.net.URI;
|
|
import java.net.URISyntaxException;
|
|
import java.text.ParseException;
|
|
import java.util.Date;
|
|
import java.util.Locale;
|
|
|
|
import javax.xml.namespace.QName;
|
|
|
|
import org.jivesoftware.smack.datatypes.UInt16;
|
|
import org.jivesoftware.smack.datatypes.UInt32;
|
|
import org.jivesoftware.smack.packet.XmlEnvironment;
|
|
import org.jivesoftware.smack.parsing.SmackParsingException;
|
|
import org.jivesoftware.smack.parsing.SmackParsingException.SmackTextParseException;
|
|
import org.jivesoftware.smack.parsing.SmackParsingException.SmackUriSyntaxParsingException;
|
|
import org.jivesoftware.smack.xml.XmlPullParser;
|
|
import org.jivesoftware.smack.xml.XmlPullParserException;
|
|
|
|
import org.jxmpp.jid.EntityBareJid;
|
|
import org.jxmpp.jid.EntityFullJid;
|
|
import org.jxmpp.jid.EntityJid;
|
|
import org.jxmpp.jid.Jid;
|
|
import org.jxmpp.jid.impl.JidCreate;
|
|
import org.jxmpp.jid.parts.Resourcepart;
|
|
import org.jxmpp.stringprep.XmppStringprepException;
|
|
import org.jxmpp.util.XmppDateTime;
|
|
|
|
public class ParserUtils {
|
|
|
|
/**
|
|
* The constant String "jid".
|
|
*/
|
|
public static final String JID = "jid";
|
|
|
|
public static void assertAtStartTag(XmlPullParser parser) throws XmlPullParserException {
|
|
assert parser.getEventType() == XmlPullParser.Event.START_ELEMENT;
|
|
}
|
|
|
|
public static void assertAtStartTag(XmlPullParser parser, String name) throws XmlPullParserException {
|
|
assertAtStartTag(parser);
|
|
assert name.equals(parser.getName());
|
|
}
|
|
|
|
public static void assertAtEndTag(XmlPullParser parser) throws XmlPullParserException {
|
|
assert parser.getEventType() == XmlPullParser.Event.END_ELEMENT;
|
|
}
|
|
|
|
public static void forwardToStartElement(XmlPullParser parser) throws XmlPullParserException, IOException {
|
|
// Wind the parser forward to the first start tag
|
|
XmlPullParser.Event event = parser.getEventType();
|
|
while (event != XmlPullParser.Event.START_ELEMENT) {
|
|
if (event == XmlPullParser.Event.END_DOCUMENT) {
|
|
throw new IllegalArgumentException("Document contains no start tag");
|
|
}
|
|
event = parser.next();
|
|
}
|
|
}
|
|
|
|
public static void forwardToEndTagOfDepth(XmlPullParser parser, int depth)
|
|
throws XmlPullParserException, IOException {
|
|
XmlPullParser.Event event = parser.getEventType();
|
|
while (!(event == XmlPullParser.Event.END_ELEMENT && parser.getDepth() == depth)) {
|
|
event = parser.next();
|
|
}
|
|
}
|
|
|
|
public static Jid getJidAttribute(XmlPullParser parser) throws XmppStringprepException {
|
|
return getJidAttribute(parser, JID);
|
|
}
|
|
|
|
public static Jid getJidAttribute(XmlPullParser parser, String name) throws XmppStringprepException {
|
|
final String jidString = parser.getAttributeValue("", name);
|
|
if (jidString == null) {
|
|
return null;
|
|
}
|
|
return JidCreate.from(jidString);
|
|
}
|
|
|
|
public static EntityBareJid getBareJidAttribute(XmlPullParser parser) throws XmppStringprepException {
|
|
return getBareJidAttribute(parser, JID);
|
|
}
|
|
|
|
public static EntityBareJid getBareJidAttribute(XmlPullParser parser, String name) throws XmppStringprepException {
|
|
final String jidString = parser.getAttributeValue("", name);
|
|
if (jidString == null) {
|
|
return null;
|
|
}
|
|
return JidCreate.entityBareFrom(jidString);
|
|
}
|
|
|
|
public static EntityFullJid getFullJidAttribute(XmlPullParser parser) throws XmppStringprepException {
|
|
return getFullJidAttribute(parser, JID);
|
|
}
|
|
|
|
public static EntityFullJid getFullJidAttribute(XmlPullParser parser, String name) throws XmppStringprepException {
|
|
final String jidString = parser.getAttributeValue("", name);
|
|
if (jidString == null) {
|
|
return null;
|
|
}
|
|
return JidCreate.entityFullFrom(jidString);
|
|
}
|
|
|
|
public static EntityJid getEntityJidAttribute(XmlPullParser parser, String name) throws XmppStringprepException {
|
|
final String jidString = parser.getAttributeValue("", name);
|
|
if (jidString == null) {
|
|
return null;
|
|
}
|
|
Jid jid = JidCreate.from(jidString);
|
|
|
|
if (!jid.hasLocalpart()) return null;
|
|
|
|
EntityFullJid fullJid = jid.asEntityFullJidIfPossible();
|
|
if (fullJid != null) {
|
|
return fullJid;
|
|
}
|
|
|
|
EntityBareJid bareJid = jid.asEntityBareJidIfPossible();
|
|
return bareJid;
|
|
}
|
|
|
|
public static Resourcepart getResourcepartAttribute(XmlPullParser parser, String name) throws XmppStringprepException {
|
|
final String resourcepartString = parser.getAttributeValue("", name);
|
|
if (resourcepartString == null) {
|
|
return null;
|
|
}
|
|
return Resourcepart.from(resourcepartString);
|
|
}
|
|
|
|
/**
|
|
* Prase a string to a boolean value as per "xs:boolean". Valid input strings are "true", "1" for true, and "false", "0" for false.
|
|
*
|
|
* @param booleanString the input string.
|
|
* @return the boolean representation of the input string
|
|
* @throws IllegalArgumentException if the input string is not valid.
|
|
* @since 4.3.2
|
|
*/
|
|
public static boolean parseXmlBoolean(String booleanString) {
|
|
switch (booleanString) {
|
|
case "true":
|
|
case "1":
|
|
return true;
|
|
case "false":
|
|
case "0":
|
|
return false;
|
|
default:
|
|
throw new IllegalArgumentException(booleanString + " is not a valid boolean string");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the boolean value of an argument.
|
|
*
|
|
* @param parser TODO javadoc me please
|
|
* @param name TODO javadoc me please
|
|
* @return the boolean value or null of no argument of the given name exists
|
|
*/
|
|
public static Boolean getBooleanAttribute(XmlPullParser parser, String name) {
|
|
String valueString = parser.getAttributeValue("", name);
|
|
if (valueString == null)
|
|
return null;
|
|
valueString = valueString.toLowerCase(Locale.US);
|
|
return parseXmlBoolean(valueString);
|
|
}
|
|
|
|
public static boolean getBooleanAttribute(XmlPullParser parser, String name,
|
|
boolean defaultValue) {
|
|
Boolean bool = getBooleanAttribute(parser, name);
|
|
if (bool == null) {
|
|
return defaultValue;
|
|
}
|
|
else {
|
|
return bool;
|
|
}
|
|
}
|
|
|
|
public static Byte getByteAttributeFromNextText(XmlPullParser parser) throws IOException, XmlPullParserException {
|
|
String nextText = parser.nextText();
|
|
return Byte.valueOf(nextText);
|
|
}
|
|
|
|
public static int getIntegerAttributeOrThrow(XmlPullParser parser, String name, String throwMessage)
|
|
throws IOException {
|
|
Integer res = getIntegerAttribute(parser, name);
|
|
if (res == null) {
|
|
// TODO Should be SmackParseException.
|
|
throw new IOException(throwMessage);
|
|
}
|
|
return res;
|
|
}
|
|
|
|
public static Integer getIntegerAttribute(XmlPullParser parser, String name) {
|
|
String valueString = parser.getAttributeValue("", name);
|
|
if (valueString == null)
|
|
return null;
|
|
return Integer.valueOf(valueString);
|
|
}
|
|
|
|
public static int getIntegerAttribute(XmlPullParser parser, String name, int defaultValue) {
|
|
Integer integer = getIntegerAttribute(parser, name);
|
|
if (integer == null) {
|
|
return defaultValue;
|
|
}
|
|
else {
|
|
return integer;
|
|
}
|
|
}
|
|
|
|
public static UInt16 getUInt16Attribute(XmlPullParser parser, String name) {
|
|
Integer integer = getIntegerAttribute(parser, name);
|
|
if (integer == null) {
|
|
return null;
|
|
}
|
|
return UInt16.from(integer);
|
|
}
|
|
|
|
public static int getIntegerFromNextText(XmlPullParser parser) throws XmlPullParserException, IOException {
|
|
String intString = parser.nextText();
|
|
return Integer.valueOf(intString);
|
|
}
|
|
|
|
public static Long getLongAttribute(XmlPullParser parser, String name) {
|
|
String valueString = parser.getAttributeValue("", name);
|
|
if (valueString == null)
|
|
return null;
|
|
return Long.valueOf(valueString);
|
|
}
|
|
|
|
public static long getLongAttribute(XmlPullParser parser, String name, long defaultValue) {
|
|
Long l = getLongAttribute(parser, name);
|
|
if (l == null) {
|
|
return defaultValue;
|
|
}
|
|
else {
|
|
return l;
|
|
}
|
|
}
|
|
|
|
public static UInt32 getUInt32Attribute(XmlPullParser parser, String name) {
|
|
Long l = getLongAttribute(parser, name);
|
|
if (l == null) {
|
|
return null;
|
|
}
|
|
return UInt32.from(l);
|
|
}
|
|
|
|
public static double getDoubleFromNextText(XmlPullParser parser) throws XmlPullParserException, IOException {
|
|
String doubleString = parser.nextText();
|
|
return Double.valueOf(doubleString);
|
|
}
|
|
|
|
public static Double getDoubleAttribute(XmlPullParser parser, String name) {
|
|
String valueString = parser.getAttributeValue("", name);
|
|
if (valueString == null)
|
|
return null;
|
|
return Double.valueOf(valueString);
|
|
}
|
|
|
|
public static double getDoubleAttribute(XmlPullParser parser, String name, long defaultValue) {
|
|
Double d = getDoubleAttribute(parser, name);
|
|
if (d == null) {
|
|
return defaultValue;
|
|
}
|
|
else {
|
|
return d;
|
|
}
|
|
}
|
|
|
|
public static Short getShortAttribute(XmlPullParser parser, String name) {
|
|
String valueString = parser.getAttributeValue("", name);
|
|
if (valueString == null) {
|
|
return null;
|
|
}
|
|
return Short.valueOf(valueString);
|
|
}
|
|
|
|
public static short getShortAttribute(XmlPullParser parser, String name, short defaultValue) {
|
|
Short s = getShortAttribute(parser, name);
|
|
if (s == null) {
|
|
return defaultValue;
|
|
}
|
|
return s;
|
|
}
|
|
|
|
public static Date getDateFromOptionalXep82String(String dateString) throws SmackTextParseException {
|
|
if (dateString == null) {
|
|
return null;
|
|
}
|
|
return getDateFromXep82String(dateString);
|
|
}
|
|
|
|
public static Date getDateFromXep82String(String dateString) throws SmackTextParseException {
|
|
try {
|
|
return XmppDateTime.parseXEP0082Date(dateString);
|
|
} catch (ParseException e) {
|
|
throw new SmackParsingException.SmackTextParseException(e);
|
|
}
|
|
}
|
|
|
|
public static Date getDateFromString(String dateString) throws SmackTextParseException {
|
|
try {
|
|
return XmppDateTime.parseDate(dateString);
|
|
} catch (ParseException e) {
|
|
throw new SmackParsingException.SmackTextParseException(e);
|
|
}
|
|
}
|
|
|
|
public static Date getDateFromNextText(XmlPullParser parser) throws XmlPullParserException, IOException, SmackTextParseException {
|
|
String dateString = parser.nextText();
|
|
return getDateFromString(dateString);
|
|
}
|
|
|
|
public static URI getUriFromNextText(XmlPullParser parser) throws XmlPullParserException, IOException, SmackUriSyntaxParsingException {
|
|
String uriString = parser.nextText();
|
|
try {
|
|
return new URI(uriString);
|
|
}
|
|
catch (URISyntaxException e) {
|
|
throw new SmackParsingException.SmackUriSyntaxParsingException(e);
|
|
}
|
|
}
|
|
|
|
public static String getRequiredAttribute(XmlPullParser parser, String name) throws IOException {
|
|
String value = parser.getAttributeValue("", name);
|
|
if (StringUtils.isNullOrEmpty(value)) {
|
|
throw new IOException("Attribute " + name + " is null or empty (" + value + ')');
|
|
}
|
|
return value;
|
|
}
|
|
|
|
public static String getRequiredNextText(XmlPullParser parser) throws XmlPullParserException, IOException {
|
|
String text = parser.nextText();
|
|
if (StringUtils.isNullOrEmpty(text)) {
|
|
throw new IOException("Next text is null or empty (" + text + ')');
|
|
}
|
|
return text;
|
|
}
|
|
|
|
public static String getXmlLang(XmlPullParser parser, XmlEnvironment xmlEnvironment) {
|
|
String currentXmlLang = getXmlLang(parser);
|
|
if (currentXmlLang != null) {
|
|
return currentXmlLang;
|
|
}
|
|
return xmlEnvironment.getEffectiveLanguage();
|
|
}
|
|
|
|
public static String getXmlLang(XmlPullParser parser) {
|
|
return parser.getAttributeValue("http://www.w3.org/XML/1998/namespace", "lang");
|
|
}
|
|
|
|
/**
|
|
* Get the QName of the current element.
|
|
*
|
|
* @param parser the parser.
|
|
* @return the Qname.
|
|
* @deprecated use {@link XmlPullParser#getQName()} instead.
|
|
*/
|
|
@Deprecated
|
|
// TODO: Remove in Smack 4.5
|
|
public static QName getQName(XmlPullParser parser) {
|
|
return parser.getQName();
|
|
}
|
|
}
|