Compare commits

...

8 Commits

Author SHA1 Message Date
Florian Schmaus b5180f819f Follow-up commit after merging support for XEP-0446: File Metadata Element
This is a follow-up commit after 441d677644 ("Initial support for
XEP-0446: File Metadata Element"). It includes the following changes

1. Use idiomatic provider design for FileMetadataElementProvider
2. Add XEP-0264 and XEP-0446 to the list of supported XEPs (both where
   added with441d6776447f)
2023-12-16 16:53:34 +01:00
Florian Schmaus 3d6fa5dbae Merge commit '441d6776447f17140b6499362be7e3e6b1f0397d' 2023-12-16 13:57:01 +01:00
Florian Schmaus 1ad394f256 [urldata] Follow-up on initial merge of XEP-0103/0104 support
This is a follow-up on 198c51356d ("Add initial support for XEP-0103
and XEP-0104: URL Address Information"), which
1. adds the entries to the support XEPs table
2. registers the provider
3. renames the package from url_address_information to urldata (aka.
   the shortname of XEP-0130).
2023-12-16 13:50:30 +01:00
Florian Schmaus 8425671b31 Merge commit '198c51356dd81a1521bba46d2d30e505d47062d1' 2023-12-16 13:25:41 +01:00
Florian Schmaus f6de30c218 Merge branch '4.4' 2023-12-11 11:18:03 +01:00
cmeng-git bd70d6abc5 [bosh] Fix BOSH debug send message not shown
Following logcat are captured with various PR fixes implemented:

// ===== Without any of the PR fixes ===== //
All the sent stanza are missing; fixed by
```
// Fix all BOSH sent debug messages not shown
  writer.flush();
```
```
2023-12-11 12:25:33.548 5470-5636/org.atalk.android D/SMACK: RECV (0):
    <body xmpp:version='1.0' authid='4867162268865181478' xmlns='http://jabber.org/protocol/httpbind' sid='53e66759d21e128cc1cba8d00aacb7421f1ea960' wait='60' ver='1.11' polling='2' inactivity='30' hold='1' xmpp:restartlogic='true' requests='2' secure='true' maxpause='120' xmlns:xmpp='urn:xmpp:xbosh' xmlns:stream='http://etherx.jabber.org/streams' from='atalk.sytes.net'>
      <stream:features>
        <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
          <mechanism>
            PLAIN
          </mechanism>
          <mechanism>
            SCRAM-SHA-1
          </mechanism>
          <mechanism>
            X-OAUTH2
          </mechanism>
        </mechanisms>
        <register xmlns='http://jabber.org/features/iq-register'/>
      </stream:features>
    </body>
2023-12-11 12:25:33.748 5470-5636/org.atalk.android D/SMACK: RECV (0):
    <body xmlns='http://jabber.org/protocol/httpbind'/>
2023-12-11 12:25:33.925 5470-5636/org.atalk.android D/SMACK: RECV (0):
    <body xmlns='http://jabber.org/protocol/httpbind'>
      <challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        cj1DI2QjJHE7JVs6LzElInQnPDhaK3JLMTUzPCtPVicvXmNuV204ei9kV1UzT1lsdCtzRW1ZTkE9PSxzPTdjNktCSnNaTHdTYjNZSytqdVRXb2c9PSxpPTQwOTY=
      </challenge>
    </body>
2023-12-11 12:25:33.939 5470-5636/org.atalk.android D/SMACK: RECV (0):
    <body xmlns='http://jabber.org/protocol/httpbind'>
      <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        dj1saEFrUzVKMFRBMEJVbTg1djd5dE4xTUpZaE09
      </success>
    </body>
```

// ===== With only PR fixes: writer.flush(); readerConsumer = null; but withoug the following fixes ===== //
// Initialize the debugger before addBOSHClientResponseListener(new BOSHPacketReader());
// BOSHPacketReader may hold and send response prior to display of the request i.e. \<response/> before \<challenge/>

```
2023-12-11 12:33:54.915 6162-6310/org.atalk.android D/SMACK: SENT (0):
    <body ver='1.8' wait='60' xmpp:version='1.0' rid='6195788493952909' xmlns:xmpp='urn:xmpp:xbosh' hold='1' xml:lang='en' ack='1' to='atalk.sytes.net' xmlns='http://jabber.org/protocol/httpbind'>
    </body>
2023-12-11 12:33:55.198 6162-6314/org.atalk.android D/SMACK: RECV (0):
    <body xmpp:version='1.0' authid='1477509259581416251' xmlns='http://jabber.org/protocol/httpbind' sid='796ae552c9fea53ff10a1979429396d19745d430' wait='60' ver='1.11' polling='2' inactivity='30' hold='1' xmpp:restartlogic='true' requests='2' secure='true' maxpause='120' xmlns:xmpp='urn:xmpp:xbosh' xmlns:stream='http://etherx.jabber.org/streams' from='atalk.sytes.net'>
      <stream:features>
        <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
          <mechanism>
            PLAIN
          </mechanism>
          <mechanism>
            SCRAM-SHA-1
          </mechanism>
          <mechanism>
            X-OAUTH2
          </mechanism>
        </mechanisms>
        <register xmlns='http://jabber.org/features/iq-register'/>
      </stream:features>
    </body>
2023-12-11 12:33:55.301 6162-6310/org.atalk.android D/SMACK: SENT (0):
    <body rid='6195788493952910' sid='796ae552c9fea53ff10a1979429396d19745d430' xmlns='http://jabber.org/protocol/httpbind'>
      <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='SCRAM-SHA-1'>
        bixhPXN3YW5AYXRhbGsuc3l0ZXMubmV0LG49c3dhbixyPUJwMTZzKG9dd0xmb1lnN0haRkAjKko7PiReIXhbKiou
      </auth>
    </body>
2023-12-11 12:33:55.534 6162-6313/org.atalk.android D/SMACK: SENT (0):
    <body rid='6195788493952911' ack='6195788493952909' sid='796ae552c9fea53ff10a1979429396d19745d430' xmlns='http://jabber.org/protocol/httpbind'>
      <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        Yz1iaXhoUFhOM1lXNUFZWFJoYkdzdWMzbDBaWE11Ym1WMExBPT0scj1CcDE2cyhvXXdMZm9ZZzdIWkZAIypKOz4kXiF4WyoqLlV4eTcvUVBCQUNKbjg1TWdRZHhjQnc9PSxwPVZlT3pkVzExN0tMc3k4THZpQWJZWDlpcW84az0=
      </response>
    </body>
2023-12-11 12:33:55.538 6162-6314/org.atalk.android D/SMACK: RECV (0):
    <body xmlns='http://jabber.org/protocol/httpbind'>
      <challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        cj1CcDE2cyhvXXdMZm9ZZzdIWkZAIypKOz4kXiF4WyoqLlV4eTcvUVBCQUNKbjg1TWdRZHhjQnc9PSxzPTdjNktCSnNaTHdTYjNZSytqdVRXb2c9PSxpPTQwOTY=
      </challenge>
    </body>
2023-12-11 12:33:55.558 6162-6310/org.atalk.android D/SMACK: SENT (0):
    <body xmpp:restart='true' rid='6195788493952912' xmlns:xmpp='urn:xmpp:xbosh' sid='796ae552c9fea53ff10a1979429396d19745d430' to='atalk.sytes.net' xmlns='http://jabber.org/protocol/httpbind'>
    </body>
2023-12-11 12:33:55.560 6162-6314/org.atalk.android D/SMACK: RECV (0):
    <body xmlns='http://jabber.org/protocol/httpbind'>
      <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        dj1mcFdSekE1SXltdTBrNys4K1hML3JncTVEd2s9
      </success>
    </body>
```

// ===== With the full PR fixes ===== //
```
2023-12-11 12:21:16.435 4703-5344/org.atalk.android D/SMACK: SENT (4):
    <body ver='1.8' wait='60' xmpp:version='1.0' rid='949729322134413' xmlns:xmpp='urn:xmpp:xbosh' hold='1' xml:lang='en' ack='1' to='atalk.sytes.net' xmlns='http://jabber.org/protocol/httpbind'>
    </body>
2023-12-11 12:21:16.637 4703-5348/org.atalk.android D/SMACK: RECV (4):
    <body xmpp:version='1.0' authid='1761920914298566866' xmlns='http://jabber.org/protocol/httpbind' sid='25ba67c4b943796418a2b7c064085327ab9c35ac' wait='60' ver='1.11' polling='2' inactivity='30' hold='1' xmpp:restartlogic='true' requests='2' secure='true' maxpause='120' xmlns:xmpp='urn:xmpp:xbosh' xmlns:stream='http://etherx.jabber.org/streams' from='atalk.sytes.net'>
      <stream:features>
        <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
          <mechanism>
            PLAIN
          </mechanism>
          <mechanism>
            SCRAM-SHA-1
          </mechanism>
          <mechanism>
            X-OAUTH2
          </mechanism>
        </mechanisms>
        <register xmlns='http://jabber.org/features/iq-register'/>
      </stream:features>
    </body>
2023-12-11 12:21:16.667 4703-5344/org.atalk.android D/SMACK: SENT (4):
    <body rid='949729322134414' sid='25ba67c4b943796418a2b7c064085327ab9c35ac' xmlns='http://jabber.org/protocol/httpbind'>
      <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='SCRAM-SHA-1'>
        bixhPXN3YW5AYXRhbGsuc3l0ZXMubmV0LG49c3dhbixyPTdiSVxeVnVMU0ZoWT8zVVlSa2psdkVMeks/e3BaQUwp
      </auth>
    </body>
2023-12-11 12:21:16.683 4703-5348/org.atalk.android D/SMACK: RECV (4):
    <body xmlns='http://jabber.org/protocol/httpbind'>
      <challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        cj03YklcXlZ1TFNGaFk/M1VZUmtqbHZFTHpLP3twWkFMKUhqVjVlVFUvdzJFaW9yQjlGdHh3T3c9PSxzPTdjNktCSnNaTHdTYjNZSytqdVRXb2c9PSxpPTQwOTY=
      </challenge>
    </body>
2023-12-11 12:21:16.689 4703-5347/org.atalk.android D/SMACK: SENT (4):
    <body rid='949729322134415' ack='949729322134413' sid='25ba67c4b943796418a2b7c064085327ab9c35ac' xmlns='http://jabber.org/protocol/httpbind'>
      <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        Yz1iaXhoUFhOM1lXNUFZWFJoYkdzdWMzbDBaWE11Ym1WMExBPT0scj03YklcXlZ1TFNGaFk/M1VZUmtqbHZFTHpLP3twWkFMKUhqVjVlVFUvdzJFaW9yQjlGdHh3T3c9PSxwPXdNb2c5N3UzQktON1FHaFVQRzQ3MHVjZXdldz0=
      </response>
    </body>
2023-12-11 12:21:16.702 4703-5348/org.atalk.android D/SMACK: RECV (4):
    <body xmlns='http://jabber.org/protocol/httpbind'>
      <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
        dj0yTzRqVzJXWHdEUDdvNjdJSkdNU3Rmc0NMTkk9
      </success>
    </body>
2023-12-11 12:21:16.704 4703-5344/org.atalk.android D/SMACK: SENT (4):
    <body xmpp:restart='true' rid='949729322134416' xmlns:xmpp='urn:xmpp:xbosh' sid='25ba67c4b943796418a2b7c064085327ab9c35ac' to='atalk.sytes.net' xmlns='http://jabber.org/protocol/httpbind'>
    </body>
```

Link: https://github.com/igniterealtime/Smack/pull/554
2023-12-11 11:16:45 +01:00
Paul Schaub 441d677644
Initial support for XEP-0446: File Metadata Element
Also adds initial support for XEP-0264: Jingle Content Thumbnails

Solves SMACK-894
2023-12-08 14:46:51 +01:00
Paul Schaub 198c51356d Add initial support for XEP-0103 and XEP-0104: URL Address Information 2020-12-31 00:10:18 +01:00
31 changed files with 2134 additions and 5 deletions

View File

@ -172,14 +172,15 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection {
client = BOSHClient.create(cfgBuilder.build());
client.addBOSHClientConnListener(new BOSHConnectionListener());
client.addBOSHClientResponseListener(new BOSHPacketReader());
// Initialize the debugger
// Initialize the debugger before addBOSHClientResponseListener(new BOSHPacketReader());
// BOSHPacketReader may hold and send response prior to display of the request i.e. <response/> before <challenge/>
if (debugger != null) {
initDebugger();
}
client.addBOSHClientConnListener(new BOSHConnectionListener());
client.addBOSHClientResponseListener(new BOSHPacketReader());
// Send the session creation request
client.send(ComposableBody.builder()
.setNamespaceDefinition("xmpp", XMPP_BOSH_NS)
@ -359,10 +360,11 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection {
CloseableUtil.maybeClose(reader, LOGGER);
CloseableUtil.maybeClose(writer, LOGGER);
// set readerConsumer = null before reader to avoid NPE reference
readerConsumer = null;
readerPipe = null;
reader = null;
writer = null;
readerConsumer = null;
}
/**
@ -440,6 +442,8 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection {
if (event.getBody() != null) {
try {
writer.write(event.getBody().toXML());
// Fix all BOSH sent debug messages not shown
writer.flush();
} catch (Exception e) {
// Ignore
}

View File

@ -0,0 +1,312 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.file_metadata.element;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.CollectionUtil;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.StringUtils;
import org.jivesoftware.smack.util.XmlStringBuilder;
import org.jivesoftware.smackx.hashes.HashManager;
import org.jivesoftware.smackx.hashes.element.HashElement;
import org.jivesoftware.smackx.thumbnails.element.ThumbnailElement;
/**
* File metadata element as defined in XEP-0446: File Metadata Element.
* This element is used in a generic way to provide information about files, e.g. during file sharing.
*/
public final class FileMetadataElement implements ExtensionElement {
public static final String ELEMENT = "file";
public static final String NAMESPACE = "urn:xmpp:file:metadata:0";
public static final String ELEM_DATE = "date";
public static final String ELEM_HEIGHT = "height";
public static final String ELEM_WIDTH = "width";
public static final String ELEM_DESC = "desc";
public static final String ELEM_LENGTH = "length";
public static final String ELEM_MEDIA_TYPE = "media-type";
public static final String ELEM_NAME = "name";
public static final String ELEM_SIZE = "size";
private final Date date;
private final Integer height;
private final Integer width;
private final Map<String, String> descriptions;
private final Map<HashManager.ALGORITHM, HashElement> hashElements;
private final Long length;
private final String mediaType;
private final String name;
private final Long size;
private final List<ThumbnailElement> thumbnails;
private FileMetadataElement(Date date, Integer height, Integer width, Map<String, String> descriptions,
Map<HashManager.ALGORITHM, HashElement> hashElements, Long length,
String mediaType, String name, Long size,
List<ThumbnailElement> thumbnails) {
this.date = date;
this.height = height;
this.width = width;
this.descriptions = CollectionUtil.cloneAndSeal(descriptions);
this.hashElements = CollectionUtil.cloneAndSeal(hashElements);
this.length = length;
this.mediaType = mediaType;
this.name = name;
this.size = size;
this.thumbnails = CollectionUtil.cloneAndSeal(thumbnails);
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
XmlStringBuilder sb = new XmlStringBuilder(this)
.rightAngleBracket()
.optElement(ELEM_DATE, date)
.optElement(ELEM_HEIGHT, height)
.optElement(ELEM_WIDTH, width);
for (String key : descriptions.keySet()) {
sb.halfOpenElement(ELEM_DESC)
.optXmlLangAttribute(key)
.rightAngleBracket()
.append(descriptions.get(key))
.closeElement(ELEM_DESC);
}
sb.append(hashElements.values())
.optElement(ELEM_LENGTH, length != null ? Long.toString(length) : null)
.optElement(ELEM_MEDIA_TYPE, mediaType)
.optElement(ELEM_NAME, name)
.optElement(ELEM_SIZE, size != null ? Long.toString(size) : null)
.append(thumbnails);
return sb.closeElement(this);
}
@Override
public String getNamespace() {
return NAMESPACE;
}
@Override
public String getElementName() {
return ELEMENT;
}
public Date getDate() {
return date;
}
public Integer getHeight() {
return height;
}
public Integer getWidth() {
return width;
}
public Map<String, String> getDescriptions() {
return Collections.unmodifiableMap(descriptions);
}
public String getDescription() {
return getDescription(getLanguage());
}
public String getDescription(String lang) {
return descriptions.get(lang != null ? lang : "");
}
public Map<HashManager.ALGORITHM, HashElement> getHashElements() {
return Collections.unmodifiableMap(hashElements);
}
public HashElement getHashElement(HashManager.ALGORITHM algorithm) {
return hashElements.get(algorithm);
}
public Long getLength() {
return length;
}
public String getMediaType() {
return mediaType;
}
/**
* Return the name of the file.
*
* @return escaped name
*/
public String getName() {
if (name == null) {
return null;
}
try {
return URLEncoder.encode(name, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw new AssertionError(e); // UTF-8 MUST be supported
}
}
public String getRawName() {
return name;
}
public Long getSize() {
return size;
}
public List<ThumbnailElement> getThumbnails() {
return Collections.unmodifiableList(thumbnails);
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getNamespace())
.append(getDate())
.append(getDescriptions())
.append(getHeight())
.append(getWidth())
.append(getHashElements())
.append(getLength())
.append(getMediaType())
.append(getRawName())
.append(getSize())
.append(getThumbnails())
.build();
}
@Override
public boolean equals(Object other) {
return EqualsUtil.equals(this, other, (equalsBuilder, o) -> equalsBuilder
.append(getElementName(), o.getElementName())
.append(getNamespace(), o.getNamespace())
.append(getDate(), o.getDate())
.append(getDescriptions(), o.getDescriptions())
.append(getHeight(), o.getHeight())
.append(getWidth(), o.getWidth())
.append(getHashElements(), o.getHashElements())
.append(getLength(), o.getLength())
.append(getMediaType(), o.getMediaType())
.append(getRawName(), o.getRawName())
.append(getSize(), o.getSize())
.append(getThumbnails(), o.getThumbnails()));
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Date date;
private Integer height;
private Integer width;
private Map<String, String> descriptions = new HashMap<>();
private Map<HashManager.ALGORITHM, HashElement> hashElements = new HashMap<>();
private Long length;
private String mediaType;
private String name;
private Long size;
private List<ThumbnailElement> thumbnails = new ArrayList<>();
public Builder setModificationDate(Date date) {
this.date = date;
return this;
}
public Builder setDimensions(int width, int height) {
return setHeight(height).setWidth(width);
}
public Builder setHeight(int height) {
if (height <= 0) {
throw new IllegalArgumentException("Height must be a positive number");
}
this.height = height;
return this;
}
public Builder setWidth(int width) {
if (width <= 0) {
throw new IllegalArgumentException("Width must be a positive number");
}
this.width = width;
return this;
}
public Builder addDescription(String description) {
return addDescription(description, null);
}
public Builder addDescription(String description, String language) {
this.descriptions.put(language != null ? language : "", StringUtils.requireNotNullNorEmpty(description, "Description MUST NOT be null nor empty"));
return this;
}
public Builder addHash(HashElement hashElement) {
hashElements.put(hashElement.getAlgorithm(), hashElement);
return this;
}
public Builder setLength(long length) {
if (length < 0) {
throw new IllegalArgumentException("Length cannot be negative.");
}
this.length = length;
return this;
}
public Builder setMediaType(String mediaType) {
this.mediaType = StringUtils.requireNotNullNorEmpty(mediaType, "Media-Type MUST NOT be null nor empty");
return this;
}
public Builder setName(String name) {
this.name = StringUtils.requireNotNullNorEmpty(name, "Name MUST NOT be null nor empty");
return this;
}
public Builder setSize(long size) {
if (size < 0) {
throw new IllegalArgumentException("Size MUST NOT be negative.");
}
this.size = size;
return this;
}
public Builder addThumbnail(ThumbnailElement thumbnail) {
thumbnails.add(thumbnail);
return this;
}
public FileMetadataElement build() {
return new FileMetadataElement(date, height, width, descriptions, hashElements, length,
mediaType, name, size, thumbnails);
}
}
}

View File

@ -0,0 +1,20 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Smacks implementation of XEP-0446: File Metadata Element.
*/
package org.jivesoftware.smackx.file_metadata.element;

View File

@ -0,0 +1,20 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Smacks implementation of XEP-0446: File Metadata Element.
*/
package org.jivesoftware.smackx.file_metadata;

View File

@ -0,0 +1,102 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.file_metadata.provider;
import java.io.IOException;
import java.text.ParseException;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.parsing.SmackParsingException;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.jivesoftware.smack.util.ParserUtils;
import org.jivesoftware.smack.xml.XmlPullParser;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.file_metadata.element.FileMetadataElement;
import org.jivesoftware.smackx.hashes.element.HashElement;
import org.jivesoftware.smackx.hashes.provider.HashElementProvider;
import org.jivesoftware.smackx.thumbnails.element.ThumbnailElement;
import org.jivesoftware.smackx.thumbnails.provider.ThumbnailElementProvider;
public class FileMetadataElementProvider extends ExtensionElementProvider<FileMetadataElement> {
@Override
public FileMetadataElement parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment)
throws XmlPullParserException, IOException, SmackParsingException, ParseException {
FileMetadataElement.Builder builder = FileMetadataElement.builder();
outerloop: while (true) {
XmlPullParser.Event event = parser.next();
switch (event) {
case START_ELEMENT:
String name = parser.getName();
switch (name) {
case FileMetadataElement.ELEMENT:
parser.next();
break;
case FileMetadataElement.ELEM_DATE:
builder.setModificationDate(ParserUtils.getDateFromNextText(parser));
break;
case FileMetadataElement.ELEM_DESC:
String lang = ParserUtils.getXmlLang(parser);
builder.addDescription(ParserUtils.getRequiredNextText(parser), lang);
break;
case "dimensions": // was replaced with width and height
String dimensions = ParserUtils.getRequiredNextText(parser);
String[] split = dimensions.split("x");
if (split.length != 2) {
throw new IllegalArgumentException("Invalid dimensions.");
}
builder.setWidth(Integer.parseInt(split[0]));
builder.setHeight(Integer.parseInt(split[1]));
break;
case FileMetadataElement.ELEM_WIDTH:
builder.setWidth(Integer.parseInt(ParserUtils.getRequiredNextText(parser)));
break;
case FileMetadataElement.ELEM_HEIGHT:
builder.setHeight(Integer.parseInt(ParserUtils.getRequiredNextText(parser)));
break;
case FileMetadataElement.ELEM_LENGTH:
builder.setLength(Long.parseLong(ParserUtils.getRequiredNextText(parser)));
break;
case FileMetadataElement.ELEM_MEDIA_TYPE:
builder.setMediaType(ParserUtils.getRequiredNextText(parser));
break;
case FileMetadataElement.ELEM_NAME:
builder.setName(ParserUtils.getRequiredNextText(parser));
break;
case FileMetadataElement.ELEM_SIZE:
builder.setSize(Long.parseLong(ParserUtils.getRequiredNextText(parser)));
break;
case HashElement.ELEMENT:
builder.addHash(HashElementProvider.INSTANCE.parse(parser, parser.getDepth(), xmlEnvironment));
break;
case ThumbnailElement.ELEMENT:
ThumbnailElementProvider provider = new ThumbnailElementProvider();
builder.addThumbnail(provider.parse(parser, parser.getDepth(), xmlEnvironment));
}
break;
case END_ELEMENT:
if (parser.getDepth() == initialDepth) break outerloop;
break;
default:
// Catch all for incomplete switch (MissingCasesInEnumSwitch) statement.
break;
}
}
return builder.build();
}
}

View File

@ -0,0 +1,20 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* File metadata element provider.
*/
package org.jivesoftware.smackx.file_metadata.provider;

View File

@ -0,0 +1,92 @@
/**
*
* Copyright 2023 Paul Schaub
*
* 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.thumbnails.element;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.Objects;
import org.jivesoftware.smack.util.XmlStringBuilder;
public class ThumbnailElement implements ExtensionElement {
public static final String ELEMENT = "thumbnail";
public static final String NAMESPACE = "urn:xmpp:thumbs:1";
public static final String ELEM_URI = "uri";
public static final String ELEM_MEDIA_TYPE = "media-type";
public static final String ELEM_WIDTH = "width";
public static final String ELEM_HEIGHT = "height";
private final String uri;
private final String mediaType;
private final Integer width;
private final Integer height;
public ThumbnailElement(String uri) {
this(uri, null, null, null);
}
public ThumbnailElement(String uri, String mediaType, Integer width, Integer height) {
this.uri = Objects.requireNonNull(uri);
this.mediaType = mediaType;
if (width != null && width < 0) {
throw new IllegalArgumentException("Width cannot be negative.");
}
this.width = width;
if (height != null && height < 0) {
throw new IllegalArgumentException("Height cannot be negative.");
}
this.height = height;
}
public String getUri() {
return uri;
}
public String getMediaType() {
return mediaType;
}
public Integer getWidth() {
return width;
}
public Integer getHeight() {
return height;
}
@Override
public CharSequence toXML(XmlEnvironment xmlEnvironment) {
XmlStringBuilder sb = new XmlStringBuilder(this, xmlEnvironment);
return sb.attribute(ELEM_URI, uri)
.optAttribute(ELEM_MEDIA_TYPE, mediaType)
.optAttribute(ELEM_WIDTH, width)
.optAttribute(ELEM_HEIGHT, height)
.closeEmptyElement();
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public String getNamespace() {
return NAMESPACE;
}
}

View File

@ -0,0 +1,20 @@
/**
*
* Copyright 2023 Paul Schaub
*
* 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.
*/
/**
* Smacks implementation of XEP-0264: Jingle Content Thumbnails.
*/
package org.jivesoftware.smackx.thumbnails.element;

View File

@ -0,0 +1,46 @@
/**
*
* Copyright 2023 Paul Schaub
*
* 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.thumbnails.provider;
import java.io.IOException;
import java.text.ParseException;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.parsing.SmackParsingException;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.jivesoftware.smack.util.ParserUtils;
import org.jivesoftware.smack.xml.XmlPullParser;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.thumbnails.element.ThumbnailElement;
public class ThumbnailElementProvider extends ExtensionElementProvider<ThumbnailElement> {
@Override
public ThumbnailElement parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment)
throws XmlPullParserException, IOException, SmackParsingException, ParseException {
String uri = parser.getAttributeValue(ThumbnailElement.ELEM_URI);
String mediaType = parser.getAttributeValue(ThumbnailElement.ELEM_MEDIA_TYPE);
Integer width = ParserUtils.getIntegerAttribute(parser, ThumbnailElement.ELEM_WIDTH);
Integer height = ParserUtils.getIntegerAttribute(parser, ThumbnailElement.ELEM_HEIGHT);
return new ThumbnailElement(
uri,
mediaType,
width,
height
);
}
}

View File

@ -0,0 +1,20 @@
/**
*
* Copyright 2023 Paul Schaub
*
* 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.
*/
/**
* Smacks implementation of XEP-0264: Jingle Content Thumbnails.
*/
package org.jivesoftware.smackx.thumbnails.provider;

View File

@ -2,6 +2,13 @@
<!-- Providers for workgroup extensions -->
<smackProviders>
<!-- XEP-0264: Jingle Content Thumbnails -->
<extensionProvider>
<elementName>thumbnail</elementName>
<namespace>urn:xmpp:thumbs:1</namespace>
<className>org.jivesoftware.smackx.thumbnails.provider.ThumbnailElementProvider</className>
</extensionProvider>
<!-- XEP-0280: Message Carbons -->
<extensionProvider>
<elementName>sent</elementName>
@ -345,6 +352,13 @@
<className>org.jivesoftware.smackx.fallback_indication.provider.FallbackIndicationElementProvider</className>
</extensionProvider>
<!-- XEP-0446: File Metadata Element -->
<extensionProvider>
<elementName>file</elementName>
<namespace>urn:xmpp:file:metadata:0</namespace>
<className>org.jivesoftware.smackx.file_metadata.provider.FileMetadataElementProvider</className>
</extensionProvider>
<!-- XEP-xxxx: Multi-User Chat Light -->
<iqProvider>
<elementName>query</elementName>

View File

@ -0,0 +1,190 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.file_metadata;
import static org.jivesoftware.smack.test.util.XmlAssertUtil.assertXmlSimilar;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import java.text.ParseException;
import java.util.Date;
import org.jivesoftware.smack.test.util.SmackTestSuite;
import org.jivesoftware.smack.test.util.SmackTestUtil;
import org.jivesoftware.smackx.file_metadata.element.FileMetadataElement;
import org.jivesoftware.smackx.file_metadata.provider.FileMetadataElementProvider;
import org.jivesoftware.smackx.hashes.HashManager;
import org.jivesoftware.smackx.hashes.element.HashElement;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
import org.jxmpp.util.XmppDateTime;
public class FileMetadataElementTest extends SmackTestSuite {
private static final Date date;
static {
try {
date = XmppDateTime.parseDate("2015-07-26T21:46:00+01:00");
} catch (ParseException e) {
throw new IllegalStateException(e);
}
}
private static final FileMetadataElement metadataElement = FileMetadataElement.builder()
.setModificationDate(date)
.setWidth(1920)
.setHeight(1080)
.addDescription("Picture of 24th XSF Summit")
.addDescription("Foto vom 24. XSF Summit", "de")
.addHash(new HashElement(HashManager.ALGORITHM.SHA_256, "2XarmwTlNxDAMkvymloX3S5+VbylNrJt/l5QyPa+YoU="))
.setLength(63000)
.setMediaType("text/plain")
.setName("text.txt")
.setSize(6144)
.build();
private static final String expectedXml = "<file xmlns='urn:xmpp:file:metadata:0'>" +
"<date>2015-07-26T20:46:00.000+00:00</date>" +
"<width>1920</width>" +
"<height>1080</height>" +
"<desc>Picture of 24th XSF Summit</desc>" +
"<desc xml:lang='de'>Foto vom 24. XSF Summit</desc>" +
"<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>2XarmwTlNxDAMkvymloX3S5+VbylNrJt/l5QyPa+YoU=</hash>" +
"<length>63000</length>" +
"<media-type>text/plain</media-type>" +
"<name>text.txt</name>" +
"<size>6144</size>" +
"</file>";
private static final String expectedLegacyXml = "<file xmlns='urn:xmpp:file:metadata:0'>" +
"<date>2015-07-26T20:46:00.000+00:00</date>" +
"<dimensions>1920x1080</dimensions>" +
"<desc>Picture of 24th XSF Summit</desc>" +
"<desc xml:lang='de'>Foto vom 24. XSF Summit</desc>" +
"<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>2XarmwTlNxDAMkvymloX3S5+VbylNrJt/l5QyPa+YoU=</hash>" +
"<length>63000</length>" +
"<media-type>text/plain</media-type>" +
"<name>text.txt</name>" +
"<size>6144</size>" +
"</file>";
@Test
public void testSerialization() {
assertXmlSimilar(expectedXml, metadataElement.toXML().toString());
}
@ParameterizedTest
@EnumSource(SmackTestUtil.XmlPullParserKind.class)
public void testParsing(SmackTestUtil.XmlPullParserKind parserKind) throws Exception {
FileMetadataElement parsed = SmackTestUtil.parse(expectedXml, FileMetadataElementProvider.class, parserKind);
assertEquals(metadataElement, parsed);
}
@ParameterizedTest
@EnumSource(SmackTestUtil.XmlPullParserKind.class)
public void testLegacyParsing(SmackTestUtil.XmlPullParserKind parserKind) throws Exception {
FileMetadataElement parsed = SmackTestUtil.parse(expectedLegacyXml, FileMetadataElementProvider.class, parserKind);
assertEquals(metadataElement, parsed);
}
@ParameterizedTest
@EnumSource(SmackTestUtil.XmlPullParserKind.class)
public void testParseUnknownExtension(SmackTestUtil.XmlPullParserKind parserKind) throws Exception {
final String xml = "<file xmlns='urn:xmpp:file:metadata:0'>" +
"<date>2015-07-26T20:46:00.000+00:00</date>" +
"<width>1920</width>" +
"<height>1080</height>" +
"<unknown-extension>foo</unknown-extension>" +
"<desc>Picture of 24th XSF Summit</desc>" +
"<desc xml:lang='de'>Foto vom 24. XSF Summit</desc>" +
"<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>2XarmwTlNxDAMkvymloX3S5+VbylNrJt/l5QyPa+YoU=</hash>" +
"<length>63000</length>" +
"<media-type>text/plain</media-type>" +
"<name>text.txt</name>" +
"<size>6144</size>" +
"</file>";
FileMetadataElement parsed = SmackTestUtil.parse(xml, FileMetadataElementProvider.class, parserKind);
assertEquals(metadataElement, parsed);
}
@Test
public void nameIsEscaped() {
FileMetadataElement e = FileMetadataElement.builder().setName("/etc/passwd").build();
assertEquals("%2Fetc%2Fpasswd", e.getName());
}
@Test
public void rejectNegativeSize() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setSize(-1));
}
@Test
public void rejectNegativeLength() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setLength(-1));
}
@Test
public void rejectNegativeWidth() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setWidth(-1));
}
@Test
public void rejectNegativeHeight() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setHeight(-1));
}
@Test
public void rejectEmptyDescription() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().addDescription(""));
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().addDescription(null));
}
@Test
public void rejectEmptyNameElement() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setName(""));
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setName(null));
}
@Test
public void rejectEmptyMediaTypeElement() {
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setMediaType(""));
assertThrows(IllegalArgumentException.class, () -> FileMetadataElement.builder().setMediaType(null));
}
@Test
public void getDescTest() {
FileMetadataElement metadataElement = FileMetadataElement.builder()
.addDescription("Foo", "br")
.addDescription("Baz")
.addDescription("Bag", "en")
.build();
assertEquals("Foo", metadataElement.getDescription("br"));
assertEquals("Baz", metadataElement.getDescription(null));
assertEquals("Baz", metadataElement.getDescription());
assertEquals("Bag", metadataElement.getDescription("en"));
assertNull(metadataElement.getDescription("null"));
assertEquals(3, metadataElement.getDescriptions().size());
}
}

View File

@ -0,0 +1,56 @@
/**
*
* Copyright 2023 Paul Schaub
*
* 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.thumbnails.element;
import static org.jivesoftware.smack.test.util.XmlAssertUtil.assertXmlSimilar;
import static org.junit.jupiter.api.Assertions.assertThrows;
import org.junit.jupiter.api.Test;
public class ThumbnailElementTest {
@Test
public void uriIsRequired() {
assertThrows(IllegalArgumentException.class, () -> new ThumbnailElement(null));
assertThrows(IllegalArgumentException.class, () -> new ThumbnailElement(null, "image/png", 128, 128));
}
@Test
public void testMinimal() {
ThumbnailElement minimal = new ThumbnailElement("cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org");
assertXmlSimilar("<thumbnail xmlns='urn:xmpp:thumbs:1'\n" +
"uri='cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org'/>",
minimal.toXML());
}
@Test
public void testFull() {
ThumbnailElement full = new ThumbnailElement(
"cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org",
"image/png",
128,
96);
assertXmlSimilar("<thumbnail xmlns='urn:xmpp:thumbs:1'\n" +
"uri='cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org'\n" +
"media-type='image/png'\n" +
"width='128'\n" +
"height='96'/>",
full.toXML());
}
}

View File

@ -0,0 +1,64 @@
/**
*
* Copyright 2023 Paul Schaub
*
* 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.thumbnails.provider;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import java.io.IOException;
import org.jivesoftware.smack.parsing.SmackParsingException;
import org.jivesoftware.smack.test.util.SmackTestUtil;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.thumbnails.element.ThumbnailElement;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
public class ThumbnailElementProviderTest {
@ParameterizedTest
@EnumSource(SmackTestUtil.XmlPullParserKind.class)
public void testParseFull(SmackTestUtil.XmlPullParserKind parserKind) throws XmlPullParserException, IOException, SmackParsingException {
String xml = "<thumbnail xmlns='urn:xmpp:thumbs:1'\n" +
"uri='cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org'\n" +
"media-type='image/png'\n" +
"width='128'\n" +
"height='96'/>";
ThumbnailElement element = SmackTestUtil.parse(xml, ThumbnailElementProvider.class, parserKind);
assertEquals("cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org", element.getUri());
assertEquals("image/png", element.getMediaType());
assertEquals(128, element.getWidth());
assertEquals(96, element.getHeight());
}
@ParameterizedTest
@EnumSource(SmackTestUtil.XmlPullParserKind.class)
public void testParseMinimal(SmackTestUtil.XmlPullParserKind parserKind) throws XmlPullParserException, IOException, SmackParsingException {
String xml = "<thumbnail xmlns='urn:xmpp:thumbs:1'\n" +
"uri='cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org'/>";
ThumbnailElement element = SmackTestUtil.parse(xml, ThumbnailElementProvider.class, parserKind);
assertEquals("cid:sha1+ffd7c8d28e9c5e82afea41f97108c6b4@bob.xmpp.org", element.getUri());
assertNull(element.getMediaType());
assertNull(element.getWidth());
assertNull(element.getHeight());
}
}

View File

@ -0,0 +1,67 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.element;
import org.jivesoftware.smack.packet.NamedElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.XmlStringBuilder;
public class DescElement implements NamedElement {
public static final String ELEMENT = "desc";
private final String desc;
public DescElement(String desc) {
this.desc = desc;
}
public String getDesc() {
return desc;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.rightAngleBracket()
.append(getDesc())
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getDesc())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder
.append(getElementName(), other.getElementName())
.append(getDesc(), other.getDesc()));
}
}

View File

@ -0,0 +1,22 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.element;
import org.jivesoftware.smack.packet.NamedElement;
public interface MetaInformationElement extends NamedElement {
}

View File

@ -0,0 +1,160 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.element;
import java.util.ArrayList;
import java.util.List;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.NamedElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.XmlStringBuilder;
import org.jivesoftware.smackx.urldata.http.element.CookieElement;
import org.jivesoftware.smackx.urldata.http.element.HeaderElement;
import org.jivesoftware.smackx.urldata.http.element.HttpAuthElement;
/**
* The url-data element.
*/
public class UrlDataElement implements ExtensionElement {
public static final String ELEMENT = "url-data";
public static final String NAMESPACE = "http://jabber.org/protocol/url-data";
public static final String ATTR_TARGET = "target";
public static final String ATTR_SID = "sid";
public static final String XMLNS_HTTP = "xmlns:http";
public static final String SCHEME_HTTP = "http://jabber.org/protocol/url-data/scheme/http";
private final String target;
private final String sid;
private final List<HttpAuthElement> authParamElements = new ArrayList<>();
private final List<CookieElement> cookieElements = new ArrayList<>();
private final List<HeaderElement> headerElements = new ArrayList<>();
public UrlDataElement(String target,
String sid) {
this(target, sid, null, null, null);
}
public UrlDataElement(String target,
String sid,
List<HttpAuthElement> authParamElements,
List<CookieElement> cookieElements,
List<HeaderElement> headerElements) {
this.target = target;
this.sid = sid;
if (authParamElements != null) {
this.authParamElements.addAll(authParamElements);
}
if (cookieElements != null) {
this.cookieElements.addAll(cookieElements);
}
if (headerElements != null) {
this.headerElements.addAll(headerElements);
}
}
public String getTarget() {
return target;
}
/**
* Return the optional stream identifier used for XEP-0095: Stream Initiation.
*
* @return stream identifier or null
*/
public String getSid() {
return sid;
}
public List<HttpAuthElement> getAuthParameters() {
return authParamElements;
}
public List<CookieElement> getCookies() {
return cookieElements;
}
public List<HeaderElement> getHeaders() {
return headerElements;
}
private List<NamedElement> getMetaInformationElements() {
List<NamedElement> elements = new ArrayList<>();
elements.addAll(getAuthParameters());
elements.addAll(getCookies());
elements.addAll(getHeaders());
return elements;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
List<NamedElement> metaInformation = getMetaInformationElements();
XmlStringBuilder sb = new XmlStringBuilder(this);
if (!metaInformation.isEmpty()) {
sb.attribute(XMLNS_HTTP, SCHEME_HTTP);
}
sb.attribute(ATTR_TARGET, getTarget())
.optAttribute(ATTR_SID, getSid());
if (metaInformation.isEmpty()) {
return sb.closeEmptyElement();
} else {
return sb.rightAngleBracket()
.append(metaInformation)
.closeElement(this);
}
}
@Override
public String getNamespace() {
return NAMESPACE;
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getNamespace())
.append(getTarget())
.append(getAuthParameters())
.append(getCookies())
.append(getHeaders())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder
.append(getElementName(), other.getElementName())
.append(getNamespace(), other.getNamespace())
.append(getTarget(), other.getTarget())
.append(getAuthParameters(), other.getAuthParameters())
.append(getCookies(), other.getCookies())
.append(getHeaders(), other.getHeaders()));
}
}

View File

@ -0,0 +1,23 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Element classes for XEP-0103: URL Address Information.
*
* @see <a href="https://xmpp.org/extensions/xep-0103.html"> XEP-0103 - URL Address Information</a>.
*/
package org.jivesoftware.smackx.urldata.element;

View File

@ -0,0 +1,77 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.http.element;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.XmlStringBuilder;
public class AuthParamElement extends NameValuePairElement {
public static final String ELEMENT = "auth-param";
public static final String PREFIX = "http";
public static final String NAME_REALM = "realm";
public static final String NAME_USERNAME = "username";
public static final String NAME_PASSWORD = "password";
public AuthParamElement(String name, String value) {
super(name, value);
}
public static AuthParamElement realm(String realm) {
return new AuthParamElement(NAME_REALM, realm);
}
public static AuthParamElement username(String username) {
return new AuthParamElement(NAME_USERNAME, username);
}
public static AuthParamElement password(String password) {
return new AuthParamElement(NAME_PASSWORD, password);
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return addCommonXml(new XmlStringBuilder(this))
.closeEmptyElement();
}
@Override
public String getElementName() {
return PREFIX + ':' + ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getName())
.append(getValue())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder
.append(getElementName(), other.getElementName())
.append(getName(), other.getName())
.append(getValue(), other.getValue()));
}
}

View File

@ -0,0 +1,128 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.http.element;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.XmlStringBuilder;
public class CookieElement extends NameValuePairElement {
public static final String ELEMENT = "cookie";
public static final String PREFIX = "http";
public static final String ATTR_DOMAIN = "domain";
public static final String ATTR_MAX_AGE = "max-age";
public static final String ATTR_PATH = "path";
public static final String ATTR_COMMENT = "comment";
public static final String ATTR_VERSION = "version";
public static final String ATTR_SECURE = "secure";
private final String domain;
private final Integer maxAge;
private final String path;
private final String comment;
private final String version;
private final Boolean secure;
public CookieElement(String name, String value) {
this(name, value, null, null, null, null, null, null);
}
public CookieElement(String name, String value, String domain, Integer maxAge, String path, String comment, String version, Boolean secure) {
super(name, value);
this.domain = domain;
this.maxAge = maxAge;
this.path = path;
this.comment = comment;
this.version = version;
this.secure = secure;
}
public String getPath() {
return path;
}
public int getMaxAge() {
return maxAge == null ? 0 : maxAge;
}
public String getDomain() {
return domain;
}
public String getComment() {
return comment;
}
public String getVersion() {
return version == null ? "1.0" : version;
}
public boolean isSecure() {
return secure != null && secure;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
XmlStringBuilder sb = addCommonXml(new XmlStringBuilder(this))
.optAttribute(ATTR_DOMAIN, domain)
.optAttribute(ATTR_MAX_AGE, maxAge)
.optAttribute(ATTR_PATH, path)
.optAttribute(ATTR_COMMENT, comment)
.optAttribute(ATTR_VERSION, version);
if (secure != null) {
sb.attribute(ATTR_SECURE, secure);
}
return sb.closeEmptyElement();
}
@Override
public String getElementName() {
return PREFIX + ':' + ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getName())
.append(getValue())
.append(getDomain())
.append(getMaxAge())
.append(getPath())
.append(getComment())
.append(getVersion())
.append(isSecure())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder
.append(getElementName(), other.getElementName())
.append(getName(), other.getName())
.append(getValue(), other.getValue())
.append(getDomain(), other.getDomain())
.append(getMaxAge(), other.getMaxAge())
.append(getPath(), other.getPath())
.append(getComment(), other.getComment())
.append(getVersion(), other.getVersion())
.append(isSecure(), other.isSecure()));
}
}

View File

@ -0,0 +1,61 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.http.element;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.XmlStringBuilder;
public class HeaderElement extends NameValuePairElement {
public static final String ELEMENT = "header";
public static final String PREFIX = "http";
public HeaderElement(String name, String value) {
super(name, value);
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return addCommonXml(new XmlStringBuilder(this))
.closeEmptyElement();
}
@Override
public String getElementName() {
return PREFIX + ':' + ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getName())
.append(getValue())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder
.append(getElementName(), other.getElementName())
.append(getName(), other.getName())
.append(getValue(), other.getValue()));
}
}

View File

@ -0,0 +1,123 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.http.element;
import java.util.ArrayList;
import java.util.List;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.util.EqualsUtil;
import org.jivesoftware.smack.util.HashCode;
import org.jivesoftware.smack.util.XmlStringBuilder;
import org.jivesoftware.smackx.urldata.element.MetaInformationElement;
public final class HttpAuthElement implements MetaInformationElement {
public static final String ELEMENT = "auth";
public static final String PREFIX = "http";
public static final String ATTR_SCHEME = "scheme";
public static final String SCHEME_BASIC = "basic";
private final String scheme;
private final List<AuthParamElement> params = new ArrayList<>();
public HttpAuthElement(String scheme, List<AuthParamElement> params) {
this.scheme = scheme;
if (params != null) {
this.params.addAll(params);
}
}
public static HttpAuthElement basicAuth() {
return basicAuth(null, null);
}
public static HttpAuthElement basicAuth(String username, String password) {
return basicAuth(null, username, password);
}
public static HttpAuthElement basicAuth(String realm, String username, String password) {
List<AuthParamElement> params = new ArrayList<>();
if (realm != null) {
params.add(AuthParamElement.realm(realm));
}
if (username != null) {
params.add(AuthParamElement.username(username));
}
if (password != null) {
params.add(AuthParamElement.password(password));
}
return new HttpAuthElement(SCHEME_BASIC, params);
}
public String getScheme() {
return scheme;
}
public List<AuthParamElement> getParams() {
return params;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
XmlStringBuilder sb = new XmlStringBuilder(this)
.attribute(ATTR_SCHEME, getScheme());
if (getParams().isEmpty()) {
return sb.closeEmptyElement();
} else {
return sb.rightAngleBracket()
.append(getParams())
.closeElement(this);
}
}
@Override
public String getElementName() {
return PREFIX + ':' + ELEMENT;
}
public AuthParamElement getParam(String name) {
for (AuthParamElement param : getParams()) {
if (param.getName().equals(name)) {
return param;
}
}
return null;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getScheme())
.append(getParams())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder
.append(getElementName(), other.getElementName())
.append(getScheme(), other.getScheme())
.append(getParams(), other.getParams()));
}
}

View File

@ -0,0 +1,49 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.http.element;
import org.jivesoftware.smack.util.XmlStringBuilder;
import org.jivesoftware.smackx.urldata.element.MetaInformationElement;
public abstract class NameValuePairElement implements MetaInformationElement {
public static final String ATTR_NAME = "name";
public static final String ATTR_VALUE = "value";
private final String name;
private final String value;
public NameValuePairElement(String name, String value) {
this.name = name;
this.value = value;
}
public String getName() {
return name;
}
public String getValue() {
return value;
}
public XmlStringBuilder addCommonXml(XmlStringBuilder sb) {
return sb.attribute(ATTR_NAME, getName())
.attribute(ATTR_VALUE, getValue());
}
}

View File

@ -0,0 +1,21 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Element classes for XEP-0104.
*/
package org.jivesoftware.smackx.urldata.http.element;

View File

@ -0,0 +1,23 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Smack's API for XEP-0104: HTTP Scheme for URL Address Information.
*
* @see <a href="https://xmpp.org/extensions/xep-0104.html"> XEP-0104 - HTTP Scheme for URL Address Information</a>
*/
package org.jivesoftware.smackx.urldata.http;

View File

@ -0,0 +1,21 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Smack's API for <a href="https://xmpp.org/extensions/xep-0103.html"> XEP-0103 - URL Address Information</a>.
*/
package org.jivesoftware.smackx.urldata;

View File

@ -0,0 +1,101 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata.provider;
import static org.jivesoftware.smackx.urldata.element.UrlDataElement.ATTR_SID;
import static org.jivesoftware.smackx.urldata.element.UrlDataElement.ATTR_TARGET;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.parsing.SmackParsingException;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.jivesoftware.smack.util.ParserUtils;
import org.jivesoftware.smack.xml.XmlPullParser;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.urldata.element.UrlDataElement;
import org.jivesoftware.smackx.urldata.http.element.AuthParamElement;
import org.jivesoftware.smackx.urldata.http.element.CookieElement;
import org.jivesoftware.smackx.urldata.http.element.HeaderElement;
import org.jivesoftware.smackx.urldata.http.element.HttpAuthElement;
public class UrlDataElementProvider extends ExtensionElementProvider<UrlDataElement> {
@Override
public UrlDataElement parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
String target = parser.getAttributeValue(ATTR_TARGET);
String sid = parser.getAttributeValue(ATTR_SID);
List<HttpAuthElement> authElements = new ArrayList<>();
List<CookieElement> cookieElements = new ArrayList<>();
List<HeaderElement> headerElements = new ArrayList<>();
do {
XmlPullParser.TagEvent event = parser.nextTag();
String name = parser.getName();
if (event == XmlPullParser.TagEvent.START_ELEMENT) {
switch (name) {
case UrlDataElement.ELEMENT:
continue;
case HttpAuthElement.ELEMENT:
String scheme = parser.getAttributeValue(HttpAuthElement.ATTR_SCHEME);
List<AuthParamElement> authParamElements = new ArrayList<>();
int innerDepth = parser.getDepth();
do {
XmlPullParser.TagEvent innerTag = parser.nextTag();
String innerName = parser.getName();
if (innerTag.equals(XmlPullParser.TagEvent.START_ELEMENT)) {
if (innerName.equals(AuthParamElement.ELEMENT)) {
String attrName = ParserUtils.getRequiredAttribute(parser, AuthParamElement.ATTR_NAME);
String attrVal = ParserUtils.getRequiredAttribute(parser, AuthParamElement.ATTR_VALUE);
authParamElements.add(new AuthParamElement(attrName, attrVal));
}
}
} while (parser.getDepth() != innerDepth);
authElements.add(new HttpAuthElement(scheme, authParamElements));
break;
case CookieElement.ELEMENT:
String cookieName = ParserUtils.getRequiredAttribute(parser, CookieElement.ATTR_NAME);
String cookieValue = ParserUtils.getRequiredAttribute(parser, CookieElement.ATTR_VALUE);
String cookieDomain = parser.getAttributeValue(CookieElement.ATTR_DOMAIN);
Integer cookieMaxAge = ParserUtils.getIntegerAttribute(parser, CookieElement.ATTR_MAX_AGE);
String cookiePath = parser.getAttributeValue(CookieElement.ATTR_PATH);
String cookieComment = parser.getAttributeValue(CookieElement.ATTR_COMMENT);
Boolean cookieSecure = ParserUtils.getBooleanAttribute(parser, CookieElement.ATTR_SECURE);
String cookieVersion = parser.getAttributeValue(CookieElement.ATTR_VERSION);
cookieElements.add(new CookieElement(cookieName, cookieValue, cookieDomain, cookieMaxAge, cookiePath, cookieComment, cookieVersion, cookieSecure));
break;
case HeaderElement.ELEMENT:
String headerName = ParserUtils.getRequiredAttribute(parser, HeaderElement.ATTR_NAME);
String headerValue = ParserUtils.getRequiredAttribute(parser, HeaderElement.ATTR_VALUE);
headerElements.add(new HeaderElement(headerName, headerValue));
break;
}
}
} while (parser.getDepth() != initialDepth);
return new UrlDataElement(target, sid, authElements, cookieElements, headerElements);
}
}

View File

@ -0,0 +1,23 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.
*/
/**
* Provider classes for XEP-0103: URL Address Information.
*
* @see <a href="https://xmpp.org/extensions/xep-0103.html"> XEP-0103 - URL Address Information</a>.
*/
package org.jivesoftware.smackx.urldata.provider;

View File

@ -365,6 +365,13 @@
<className>org.jivesoftware.smackx.si.provider.StreamInitiationProvider</className>
</iqProvider>
<!-- XEP-0103: URL Address Information -->
<extensionProvider>
<elementName>url-data</elementName>
<namespace>http://jabber.org/protocol/url-data</namespace>
<className>org.jivesoftware.smackx.urldata.provider.UrlDataElementProvider</className>
</extensionProvider>
<!-- XEP-0107: User Mood -->
<extensionProvider>
<elementName>mood</elementName>

View File

@ -0,0 +1,219 @@
/**
*
* Copyright 2020 Paul Schaub
*
* 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.urldata;
import static org.jivesoftware.smack.test.util.XmlAssertUtil.assertXmlSimilar;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import org.jivesoftware.smack.parsing.SmackParsingException;
import org.jivesoftware.smack.test.util.SmackTestSuite;
import org.jivesoftware.smack.test.util.TestUtils;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.urldata.element.UrlDataElement;
import org.jivesoftware.smackx.urldata.http.element.CookieElement;
import org.jivesoftware.smackx.urldata.http.element.HeaderElement;
import org.jivesoftware.smackx.urldata.http.element.HttpAuthElement;
import org.jivesoftware.smackx.urldata.provider.UrlDataElementProvider;
import org.junit.jupiter.api.Test;
public class UrlDataElementTest extends SmackTestSuite {
public static final UrlDataElementProvider URL_DATA_ELEMENT_PROVIDER = new UrlDataElementProvider();
@Test
public void simpleSerializationTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement("http://www.jabber.org/members/index.php",
null,
Collections.singletonList(HttpAuthElement.basicAuth()),
null, null);
final String expectedXml = "" +
"<url-data xmlns='http://jabber.org/protocol/url-data' " +
"xmlns:http='http://jabber.org/protocol/url-data/scheme/http' " +
"target='http://www.jabber.org/members/index.php'>" +
"<http:auth scheme='basic'/>" +
"</url-data>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void additionalAuthParamTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement("http://www.jabber.org/members/index.php",
null,
Collections.singletonList(HttpAuthElement.basicAuth(
"www.jabber.org",
"defaultuser",
"defaultpwd"
)),
null,
null);
final String expectedXml = "<url-data xmlns='http://jabber.org/protocol/url-data'\n" +
" xmlns:http='http://jabber.org/protocol/url-data/scheme/http'\n" +
" target='http://www.jabber.org/members/index.php'>\n" +
" <http:auth scheme='basic'>\n" +
" <http:auth-param name='realm' value='www.jabber.org'/>\n" +
" <http:auth-param name='username' value='defaultuser'/>\n" +
" <http:auth-param name='password' value='defaultpwd'/>\n" +
" </http:auth>\n" +
" </url-data>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void simpleUrlWithSidTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement("http://pass.jabber.org:8519/test.txt", "a0");
final String expectedXml = "<url-data xmlns='http://jabber.org/protocol/url-data'\n" +
" sid='a0'\n" +
" target='http://pass.jabber.org:8519/test.txt'/>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void simpleUrlNoChildrenTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement("http://festhall.outer-planes.net/d20M/announce/latest/", null);
final String expectedXml = "<url-data\n" +
" xmlns='http://jabber.org/protocol/url-data'\n" +
" target='http://festhall.outer-planes.net/d20M/announce/latest/'/>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void simpleCookieTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement("http://www.jabber.org/members/index.php",
null,
null,
Collections.singletonList(new CookieElement("jsessionid", "1243asd234190sa32ds")),
null);
final String expectedXml = "" +
"<url-data xmlns='http://jabber.org/protocol/url-data'\n" +
" xmlns:http='http://jabber.org/protocol/url-data/scheme/http'\n" +
" target='http://www.jabber.org/members/index.php'>\n" +
" <http:cookie name='jsessionid' value='1243asd234190sa32ds'/>\n" +
"</url-data>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void additionalParametersCookieTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement("http://www.jabber.org/members/index.php",
null,
null,
Collections.singletonList(new CookieElement(
"jsessionid",
"1243asd234190sa32ds",
"jabber.org",
1234000,
"/members",
"Web Session Identifier",
"1.0",
false
)),
null);
final String expectedXml = "<url-data xmlns='http://jabber.org/protocol/url-data'\n" +
" xmlns:http='http://jabber.org/protocol/url-data/scheme/http'\n" +
" target='http://www.jabber.org/members/index.php'>\n" +
" <http:cookie name='jsessionid'\n" +
" domain='jabber.org'\n" +
" max-age='1234000'\n" +
" path='/members'\n" +
" comment='Web Session Identifier'\n" +
" version='1.0'\n" +
" secure='false'\n" +
" value='1243asd234190sa32ds'/>\n" +
"</url-data>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void simpleHeaderTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement(
"http://www.jabber.org/members/index.php",
null,
null,
null,
Collections.singletonList(new HeaderElement("Custom-Data", "some custom data")));
final String expectedXml = "<url-data xmlns='http://jabber.org/protocol/url-data'\n" +
" xmlns:http='http://jabber.org/protocol/url-data/scheme/http'\n" +
" target='http://www.jabber.org/members/index.php'>\n" +
" <http:header name='Custom-Data' value='some custom data'/>\n" +
" </url-data>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
@Test
public void multiChildTest() throws XmlPullParserException, IOException, SmackParsingException {
UrlDataElement urlDataElement = new UrlDataElement(
"https://blog.jabberhead.tk",
null,
Collections.singletonList(HttpAuthElement.basicAuth()),
Arrays.asList(
new CookieElement("jsessionid", "somecookievalue"),
new CookieElement("come2darkSide", "weHaveCookies")),
Arrays.asList(
new HeaderElement("Accept", "text/plain"),
new HeaderElement("Access-Control-Allow-Origin", "*")));
final String expectedXml =
"<url-data xmlns='http://jabber.org/protocol/url-data'\n" +
" xmlns:http='http://jabber.org/protocol/url-data/scheme/http'\n" +
" target='https://blog.jabberhead.tk'>\n" +
" <http:auth scheme='basic'/>\n" +
" <http:cookie name='jsessionid' value='somecookievalue'/>\n" +
" <http:cookie name='come2darkSide' value='weHaveCookies'/>\n" +
" <http:header name='Accept' value='text/plain'/>\n" +
" <http:header name='Access-Control-Allow-Origin' value='*'/>\n" +
" </url-data>";
assertXmlSimilar(expectedXml, urlDataElement.toXML().toString());
UrlDataElement parsed = URL_DATA_ELEMENT_PROVIDER.parse(TestUtils.getParser(expectedXml));
assertEquals(urlDataElement, parsed);
}
}

View File

@ -206,6 +206,18 @@
* <td>Transfer files between two users over XMPP.</td>
* </tr>
* <tr>
* <td>URL Address Information</td>
* <td><a href="https://xmpp.org/extensions/xep-0103.html">XEP-0103</a></td>
* <td>{@link org.jivesoftware.smackx.urldata.element}</td>
* <td>Provide information about an Uniform Resource Locator (URL), and a protocol signaling retrieval states.</td>
* </tr>
* <tr>
* <td>HTTP Scheme for URL Data</td>
* <td><a href="https://xmpp.orf/extensions/xep-0104.html">XEP-0104</a></td>
* <td></td>
* <td>A schema description for detailed information about HTTP URLs.</td>
* </tr>
* <tr>
* <td>User Mood</td>
* <td><a href="https://xmpp.org/extensions/xep-0107.html">XEP-0107</a></td>
* <td></td>
@ -358,6 +370,12 @@
* <td>Allows sending a MUC invitation directly from the user to the contact with mediation by the room.</td>
* </tr>
* <tr>
* <td>Jingle Content Thumbnails</td>
* <td><a href="https://xmpp.org/extensions/xep-0264.html">XEP-0264</a></td>
* <td>{@link org.jivesoftware.smackx.thumbnails.element}</td>
* <td>Defines a way for a client to supply a preview image for Jingle content.</td>
* </tr>
* <tr>
* <td>Message Carbons</td>
* <td><a href="https://xmpp.org/extensions/xep-0280.html">XEP-0280</a></td>
* <td>{@link org.jivesoftware.smackx.carbons}</td>
@ -571,6 +589,12 @@
* <td>Declare body elements of a message as ignorable fallback for naive legacy clients.</td>
* </tr>
* <tr>
* <td>File metadata element</td>
* <td><a href="https://xmpp.org/extensions/xep-0446.html">XEP-0446</a></td>
* <td>{@link org.jivesoftware.smackx.file_metadata.element}</td>
* <td>Defines a generic file metadata element to be used in other specifications.</td>
* </tr>
* <tr>
* <td>Google GCM JSON payload</td>
* <td></td>
* <td></td>