vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-12-22 18:48:00 +01:00
Code Issues Releases Wiki Activity

Implement Last Message Correction (XEP-0308)

Browse source 
Fixes SMACK-714
This commit is contained in:
ramabit 2016-04-05 14:51:34 -03:00 committed by Florian Schmaus
parent b94b2586e2
commit ca58c65a26
5 changed files with 236 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/MessageCorrectExtension.java Normal file
View file

@ -0,0 +1,105 @@
/**
*
* Copyright 2016 Fernando Ramirez
*
* 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.message_correct;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
* An Extension that implements XEP-0308: Last Message Correction
*
* This extension is expected to be added to message stanzas. Please refer to
* the XEP for more implementation guidelines.
*
* @author Fernando Ramirez, f.e.ramirez94@gmail.com
* @see <a href="http://xmpp.org/extensions/xep-0308.html">XEP-0308:&nbsp;Last&
* nbsp;Message&nbsp;Correction</a>
*/
public class MessageCorrectExtension implements ExtensionElement {
/**
* The XML element name of a 'message correct' extension.
*/
public static final String ELEMENT = "replace";
/**
* The namespace that qualifies the XML element of a 'message correct'
* extension.
*/
public static final String NAMESPACE = "urn:xmpp:message-correct:0";
/**
* The id tag of a 'message correct' extension.
*/
public static final String ID_TAG = "id";
/**
* The id of the message to correct.
*/
private String idInitialMessage;
public MessageCorrectExtension(String idInitialMessage) {
this.setIdInitialMessage(idInitialMessage);
}
public String getIdInitialMessage() {
return idInitialMessage;
}
public void setIdInitialMessage(String idInitialMessage) {
this.idInitialMessage = idInitialMessage;
}
/*
* (non-Javadoc)
*
* @see org.jivesoftware.smack.packet.PacketExtension#getElementName()
*/
@Override
public String getElementName() {
return ELEMENT;
}
/*
* (non-Javadoc)
*
* @see org.jivesoftware.smack.packet.PacketExtension#toXML()
*/
@Override
public XmlStringBuilder toXML() {
XmlStringBuilder xml = new XmlStringBuilder(this);
xml.attribute(ID_TAG, getIdInitialMessage());
xml.closeEmptyElement();
return xml;
}
/*
* (non-Javadoc)
*
* @see org.jivesoftware.smack.packet.PacketExtension#getNamespace()
*/
@Override
public String getNamespace() {
return NAMESPACE;
}
public static MessageCorrectExtension from(Message message) {
return message.getExtension(ELEMENT, NAMESPACE);
}
}

21
smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/package-info.java Normal file
View file

@ -0,0 +1,21 @@
/**
*
* Copyright 2016 Fernando Ramirez
*
* 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.
*/
/**
* Classes and Interfaces that implement Last Message Correction as defined in XEP-0308.
*/
package org.jivesoftware.smackx.message_correct;

42
smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/provider/MessageCorrectProvider.java Normal file
View file

@ -0,0 +1,42 @@
/**
*
* Copyright 2016 Fernando Ramirez
*
* 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.message_correct.provider;
import java.io.IOException;
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.jivesoftware.smackx.message_correct.MessageCorrectExtension;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* A ExtensionElementProvider for the MessageCorrectExtension. As
* MessageCorrection elements have only the ID of the message to replace.
*
* @author Fernando Ramirez, f.e.ramirez94@gmail.com
*/
public class MessageCorrectProvider extends ExtensionElementProvider<MessageCorrectExtension> {
@Override
public MessageCorrectExtension parse(XmlPullParser parser, int initialDepth)
throws XmlPullParserException, IOException, SmackException {
String idMessageToReplace = parser.getAttributeValue("", MessageCorrectExtension.ID_TAG);
return new MessageCorrectExtension(idMessageToReplace);
}
}

17
smack-extensions/src/main/java/org/jivesoftware/smackx/message_correct/provider/package-info.java Normal file
View file

@ -0,0 +1,17 @@
/**
*
* Copyright 2016 Fernando Ramirez
*
* 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.message_correct.provider;

51
smack-extensions/src/test/java/org/jivesoftware/smackx/message_correct/MessageCorrectExtensionTest.java Normal file
View file

@ -0,0 +1,51 @@
/**
*
* Copyright 2016 Fernando Ramirez
*
* 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.message_correct;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.util.PacketParserUtils;
import org.junit.Assert;
import org.junit.Test;
public class MessageCorrectExtensionTest {
private Message initialMessage;
private final String idInitialMessage = "bad1";
private final String initialMessageXml = "<message to='juliet@capulet.net/balcony' id='good1'>"
+ "<body>But soft, what light through yonder window breaks?</body>" + "</message>";
private final CharSequence messageCorrectionXml = "<replace xmlns='urn:xmpp:message-correct:0' id='bad1'/>";
private final CharSequence expectedXml = "<message to='juliet@capulet.net/balcony' id='good1'>"
+ "<body>But soft, what light through yonder window breaks?</body>"
+ "<replace xmlns='urn:xmpp:message-correct:0' id='bad1'/>" + "</message>";
@Test
public void checkStanzas() throws Exception {
initialMessage = (Message) PacketParserUtils.parseStanza(initialMessageXml);
MessageCorrectExtension messageCorrectExtension = new MessageCorrectExtension(idInitialMessage);
Assert.assertEquals(messageCorrectExtension.toXML().toString(), messageCorrectionXml);
initialMessage.addExtension(messageCorrectExtension);
Assert.assertEquals(initialMessage.toXML(), expectedXml);
}
}