mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-12-24 03:27:59 +01:00
Blocking Command: add blocked error management and refactor SMACK-731
This commit is contained in:
parent
5c2d18deb4
commit
018a7dd93a
6 changed files with 186 additions and 7 deletions
|
@ -8,6 +8,7 @@ Allows to manage communications blocking.
|
|||
* Block contact
|
||||
* Unblock contact
|
||||
* Unblock all
|
||||
* Check if a message has a blocked error
|
||||
|
||||
|
||||
**XEP related:** [XEP-0191](http://xmpp.org/extensions/xep-0191.html)
|
||||
|
@ -61,3 +62,13 @@ Unblock all
|
|||
```
|
||||
blockingCommandManager.unblockAll();
|
||||
```
|
||||
|
||||
|
||||
Check if a message has a blocked error
|
||||
--------------------------------------
|
||||
|
||||
```
|
||||
BlockedErrorExtension.isInside(message));
|
||||
```
|
||||
*message* is a `Message`
|
||||
|
||||
|
|
|
@ -163,14 +163,12 @@ public final class BlockingCommandManager extends Manager {
|
|||
public List<Jid> getBlockList()
|
||||
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
|
||||
|
||||
if (blockListCached != null) {
|
||||
return Collections.unmodifiableList(blockListCached);
|
||||
if (blockListCached == null) {
|
||||
BlockListIQ blockListIQ = new BlockListIQ();
|
||||
BlockListIQ blockListIQResult = connection().createPacketCollectorAndSend(blockListIQ).nextResultOrThrow();
|
||||
blockListCached = blockListIQResult.getBlockedJidsCopy();
|
||||
}
|
||||
|
||||
BlockListIQ blockListIQ = new BlockListIQ();
|
||||
BlockListIQ blockListIQResult = connection().createPacketCollectorAndSend(blockListIQ).nextResultOrThrow();
|
||||
blockListCached = blockListIQResult.getBlockedJidsCopy();
|
||||
|
||||
return Collections.unmodifiableList(blockListCached);
|
||||
}
|
||||
|
||||
|
|
|
@ -0,0 +1,75 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2016-2017 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.blocking.element;
|
||||
|
||||
import org.jivesoftware.smack.packet.ExtensionElement;
|
||||
import org.jivesoftware.smack.packet.Message;
|
||||
import org.jivesoftware.smack.packet.XMPPError;
|
||||
import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||
import org.jivesoftware.smackx.blocking.BlockingCommandManager;
|
||||
|
||||
/**
|
||||
* Blocked error extension class.
|
||||
*
|
||||
* @author Fernando Ramirez
|
||||
* @see <a href="http://xmpp.org/extensions/xep-0191.html">XEP-0191: Blocking
|
||||
* Command</a>
|
||||
*/
|
||||
public class BlockedErrorExtension implements ExtensionElement {
|
||||
|
||||
public static final String ELEMENT = "blocked";
|
||||
public static final String NAMESPACE = BlockingCommandManager.NAMESPACE + ":errors";
|
||||
|
||||
@Override
|
||||
public String getElementName() {
|
||||
return ELEMENT;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getNamespace() {
|
||||
return NAMESPACE;
|
||||
}
|
||||
|
||||
@Override
|
||||
public CharSequence toXML() {
|
||||
XmlStringBuilder xml = new XmlStringBuilder(this);
|
||||
xml.closeEmptyElement();
|
||||
return xml;
|
||||
}
|
||||
|
||||
public static BlockedErrorExtension from(Message message) {
|
||||
XMPPError error = message.getError();
|
||||
if (error == null) {
|
||||
return null;
|
||||
}
|
||||
return error.getExtension(ELEMENT, NAMESPACE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a message contains a BlockedErrorExtension, which means that a
|
||||
* message was blocked because the JID blocked the sender, and that was
|
||||
* reflected back as an error message.
|
||||
*
|
||||
* @param message
|
||||
* @return true if the message contains a BlockedErrorExtension, false if
|
||||
* not
|
||||
*/
|
||||
public static boolean isInside(Message message) {
|
||||
return from(message) != null;
|
||||
}
|
||||
|
||||
}
|
|
@ -0,0 +1,37 @@
|
|||
/**
|
||||
*
|
||||
* 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.blocking.provider;
|
||||
|
||||
import org.jivesoftware.smack.provider.ExtensionElementProvider;
|
||||
import org.jivesoftware.smackx.blocking.element.BlockedErrorExtension;
|
||||
import org.xmlpull.v1.XmlPullParser;
|
||||
|
||||
/**
|
||||
* Blocked error extension class.
|
||||
*
|
||||
* @author Fernando Ramirez
|
||||
* @see <a href="http://xmpp.org/extensions/xep-0191.html">XEP-0191: Blocking
|
||||
* Command</a>
|
||||
*/
|
||||
public class BlockedErrorExtensionProvider extends ExtensionElementProvider<BlockedErrorExtension> {
|
||||
|
||||
@Override
|
||||
public BlockedErrorExtension parse(XmlPullParser parser, int initialDepth) throws Exception {
|
||||
return new BlockedErrorExtension();
|
||||
}
|
||||
|
||||
}
|
|
@ -531,6 +531,10 @@
|
|||
<namespace>urn:xmpp:blocking</namespace>
|
||||
<className>org.jivesoftware.smackx.blocking.provider.UnblockContactsIQProvider</className>
|
||||
</iqProvider>
|
||||
<extensionProvider>
|
||||
<elementName>blocked</elementName>
|
||||
<namespace>urn:xmpp:blocking:errors</namespace>
|
||||
<className>org.jivesoftware.smackx.blocking.provider.BlockedErrorExtensionProvider</className>
|
||||
</extensionProvider>
|
||||
|
||||
|
||||
</smackProviders>
|
||||
|
|
|
@ -0,0 +1,54 @@
|
|||
/**
|
||||
*
|
||||
* 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.blocking;
|
||||
|
||||
import org.jivesoftware.smack.packet.Message;
|
||||
import org.jivesoftware.smack.util.PacketParserUtils;
|
||||
import org.jivesoftware.smackx.blocking.element.BlockedErrorExtension;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
|
||||
public class BlockedErrorExtensionTest {
|
||||
|
||||
String messageWithoutError = "<message from='gardano@erlang-solutions.com' "
|
||||
+ "to='griveroa-inaka@erlang-solutions.com/9b7b3fce28742983' "
|
||||
+ "type='normal' xml:lang='en' id='5x41G-120'>" + "</message>";
|
||||
|
||||
String messageWithError = "<message from='gardano@erlang-solutions.com' "
|
||||
+ "to='griveroa-inaka@erlang-solutions.com/9b7b3fce28742983' "
|
||||
+ "type='error' xml:lang='en' id='5x41G-121'>" + "<error code='406' type='cancel'>"
|
||||
+ "<not-acceptable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>" + "</error>" + "</message>";
|
||||
|
||||
String messageWithBlockedError = "<message from='gardano@erlang-solutions.com' "
|
||||
+ "to='griveroa-inaka@erlang-solutions.com/9b7b3fce28742983' "
|
||||
+ "type='error' xml:lang='en' id='5x41G-122'>" + "<error code='406' type='cancel'>"
|
||||
+ "<blocked xmlns='urn:xmpp:blocking:errors'/>"
|
||||
+ "<not-acceptable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>" + "</error>" + "</message>";
|
||||
|
||||
@Test
|
||||
public void checkErrorHasBlockedExtension() throws Exception {
|
||||
Message message1 = (Message) PacketParserUtils.parseStanza(messageWithoutError);
|
||||
Assert.assertFalse(BlockedErrorExtension.isInside(message1));
|
||||
|
||||
Message message2 = (Message) PacketParserUtils.parseStanza(messageWithError);
|
||||
Assert.assertFalse(BlockedErrorExtension.isInside(message2));
|
||||
|
||||
Message message3 = (Message) PacketParserUtils.parseStanza(messageWithBlockedError);
|
||||
Assert.assertTrue(BlockedErrorExtension.isInside(message3));
|
||||
}
|
||||
|
||||
}
|
Loading…
Reference in a new issue