vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-22 03:52:06 +01:00
Code Issues Releases Wiki Activity

Initial support for XEP-0446: File Metadata Element

Browse source 
Solves SMACK-894
This commit is contained in:
Paul Schaub 2020-12-30 15:32:38 +01:00
parent b5180f819f
commit b3b78caa64
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
9 changed files with 644 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/DateElement.java Normal file
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.file_metadata.element.child;
import java.util.Date;
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.jxmpp.util.XmppDateTime;
/**
* Timestamp specifying the last modified time of the file.
*/
public class DateElement implements NamedElement {
public static final String ELEMENT = "date";
private final Date date;
public DateElement(Date date) {
this.date = date;
}
/**
* Return the last modification date of the file.
*
* @return last modification date
*/
public Date getDate() {
return date;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
XmlStringBuilder sb = new XmlStringBuilder(this).rightAngleBracket();
sb.append(XmppDateTime.formatXEP0082Date(getDate()));
return sb.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getDate())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getDate(), other.getDate()));
}
}

94
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/DescElement.java Normal file
View file

@ -0,0 +1,94 @@
/**
*
* 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.child;
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.StringUtils;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
* A human readable description of the file. Multiple {@link DescElement DescElements} MAY be included
* if different xml:lang values are specified.
*/
public class DescElement implements NamedElement {
public static final String ELEMENT = "desc";
private final String description;
private final String lang;
public DescElement(String description) {
this(description, null);
}
public DescElement(String description, String lang) {
this.description = StringUtils.requireNotNullNorEmpty(description, "Description MUST NOT be null nor empty");
this.lang = lang;
}
/**
* Return the description of the file.
*
* @return description
*/
public String getDescription() {
return description;
}
/**
* Return the language of the description or null.
*
* @return language or null
*/
public String getLanguage() {
return lang;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.optXmlLangAttribute(getLanguage())
.rightAngleBracket()
.append(getDescription())
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getLanguage())
.append(getDescription())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getLanguage(), other.getLanguage())
.append(getDescription(), other.getDescription()));
}
}

75
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/DimensionsElement.java Normal file
View file

@ -0,0 +1,75 @@
/**
*
* 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.child;
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.StringUtils;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
* Horizontal and vertical dimensions of image or video files, in pixels.
*/
public class DimensionsElement implements NamedElement {
public static final String ELEMENT = "dimensions";
private final String dimensions;
public DimensionsElement(String dimensions) {
this.dimensions = StringUtils.requireNotNullNorEmpty(dimensions, "Dimensions MUST NOT be null nor empty.");
}
/**
* Return the dimensions of the file in width by height (eg. 1920x1080).
*
* @return dimensions
*/
public String getDimensions() {
return dimensions;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.rightAngleBracket()
.append(getDimensions())
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getDimensions())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getDimensions(), other.getDimensions()));
}
}

77
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/LengthElement.java Normal file
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.file_metadata.element.child;
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;
/**
* Length of an audio or video file, in milliseconds.
*/
public class LengthElement implements NamedElement {
public static final String ELEMENT = "length";
private final long length;
public LengthElement(long length) {
if (length < 0) {
throw new IllegalArgumentException("Length cannot be negative.");
}
this.length = length;
}
/**
* Return the length of the audio or video file.
*
* @return length in milliseconds
*/
public long getLength() {
return length;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.rightAngleBracket()
.append(Long.toString(getLength()))
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getLength())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getLength(), other.getLength()));
}
}

78
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/MediaTypeElement.java Normal file
View file

@ -0,0 +1,78 @@
/**
*
* 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.child;
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.StringUtils;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
* The media type of the file content, which SHOULD be a valid MIME-TYPE as registered with the
* Internet Assigned Numbers Authority (IANA).
*
* @see <a href="http://www.iana.org/assignments/media-types">Media Types</a>
*/
public class MediaTypeElement implements NamedElement {
public static final String ELEMENT = "media-type";
private final String mediaType;
public MediaTypeElement(String mediaType) {
this.mediaType = StringUtils.requireNotNullNorEmpty(mediaType, "Media-Type MUST NOT be null nor empty");
}
/**
* Return the media type of the file.
*
* @return media type
*/
public String getMediaType() {
return mediaType;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.rightAngleBracket()
.append(getMediaType())
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getMediaType())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getMediaType(), other.getMediaType()));
}
}

94
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/NameElement.java Normal file
View file

@ -0,0 +1,94 @@
/**
*
* 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.child;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
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.StringUtils;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
* The name of the file.
*/
public class NameElement implements NamedElement {
public static final String ELEMENT = "name";
private final String name;
public NameElement(String name) {
this.name = StringUtils.requireNotNullNorEmpty(name, "Name MUST NOT be null nor empty");
}
/**
* Return the name of the file.
*
* @return escaped name
*/
public String getName() {
try {
return URLEncoder.encode(name, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw new AssertionError(e); // UTF-8 MUST be supported
}
}
/**
* Return the text value of this element in its raw form.
* Note: Use {@link #getName()} instead when interpreting the name inside a directory structure.
*
* @see <a href="https://xmpp.org/extensions/xep-0446.html#security">XEP-0446 §3. Security Considerations</a>
* @return raw unescaped name
*/
public String getRawName() {
return name;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.rightAngleBracket()
.append(getName())
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getRawName())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getRawName(), other.getRawName()));
}
}

72
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/SizeElement.java Normal file
View file

@ -0,0 +1,72 @@
/**
*
* 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.child;
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;
/**
* The length of the file's content, in bytes.
*/
public class SizeElement implements NamedElement {
public static final String ELEMENT = "size";
private final long size;
public SizeElement(long size) {
if (size < 0) {
throw new IllegalArgumentException("Size MUST NOT be negative.");
}
this.size = size;
}
public long getSize() {
return size;
}
@Override
public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
return new XmlStringBuilder(this)
.rightAngleBracket()
.append(Long.toString(getSize()))
.closeElement(this);
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public int hashCode() {
return HashCode.builder()
.append(getElementName())
.append(getSize())
.build();
}
@Override
public boolean equals(Object obj) {
return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
equalsBuilder.append(getElementName(), other.getElementName())
.append(getSize(), other.getSize()));
}
}

20
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/package-info.java Normal file
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.
*/
/**
* Child elements of the file metadata element.
*/
package org.jivesoftware.smackx.file_metadata.element.child;

114
smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/provider/FileMetadataElementProvider.java
View file

@ -16,9 +16,6 @@
*/
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;
@ -31,6 +28,9 @@ import org.jivesoftware.smackx.hashes.provider.HashElementProvider;
import org.jivesoftware.smackx.thumbnails.element.ThumbnailElement;
import org.jivesoftware.smackx.thumbnails.provider.ThumbnailElementProvider;
import java.io.IOException;
import java.text.ParseException;
public class FileMetadataElementProvider extends ExtensionElementProvider<FileMetadataElement> {
@Override
@ -41,60 +41,60 @@ public class FileMetadataElementProvider extends ExtensionElementProvider<FileMe
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;
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();