Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-12-08 14:11:07 +01:00
Code Issues Releases Wiki Activity

Apply refinements and fixes to the MAM code

Browse source 
SMACK-625.
This commit is contained in:
Florian Schmaus 2016-07-23 15:45:45 +02:00
parent 189cac072b
commit aeb385a022
21 changed files with 194 additions and 236 deletions
Download patch file Download diff file Expand all files Collapse all files

86
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java
View file

@ -34,13 +34,14 @@ import org.jivesoftware.smack.XMPPConnectionRegistry;
import org.jivesoftware.smack.XMPPException.XMPPErrorException;
import org.jivesoftware.smack.filter.IQReplyFilter;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.IQ.Type;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.util.Objects;
import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
import org.jivesoftware.smackx.forward.packet.Forwarded;
import org.jivesoftware.smackx.mam.element.MamElements;
import org.jivesoftware.smackx.mam.element.MamFinIQ;
import org.jivesoftware.smackx.mam.element.MamPrefsIQ;
import org.jivesoftware.smackx.mam.element.MamPrefsIQ.DefaultBehavior;
import org.jivesoftware.smackx.mam.element.MamQueryIQ;
import org.jivesoftware.smackx.mam.filter.MamResultFilter;
import org.jivesoftware.smackx.rsm.packet.RSMSet;
@ -50,11 +51,12 @@ import org.jxmpp.jid.Jid;
import org.jxmpp.util.XmppDateTime;
/**
* Message Archive Management Manager class.
* A Manager for Message Archive Management (XEP-0313).
*
* @see <a href="http://xmpp.org/extensions/xep-0313.html">XEP-0313: Message
* Archive Management</a>
* @author Fernando Ramirez and Florian Schmaus
* @author Florian Schmaus
* @author Fernando Ramirez
*
*/
public final class MamManager extends Manager {
@ -223,7 +225,9 @@ public final class MamManager extends Manager {
addAdditionalFields(additionalFields, dataForm);
}
MamQueryIQ mamQueryIQ = prepareMamQueryIQSet(dataForm, queryId);
MamQueryIQ mamQueryIQ = new MamQueryIQ(queryId, dataForm);
mamQueryIQ.setType(IQ.Type.set);
addResultsLimit(max, mamQueryIQ);
return queryArchive(mamQueryIQ);
}
@ -273,11 +277,6 @@ public final class MamManager extends Manager {
dataForm.addField(formField);
}
private void preparePageQuery(MamQueryIQ mamQueryIQ, RSMSet rsmSet) {
mamQueryIQ.setType(IQ.Type.set);
mamQueryIQ.addExtension(rsmSet);
}
/**
* Returns a page of the archive.
*
@ -293,7 +292,8 @@ public final class MamManager extends Manager {
public MamQueryResult page(DataForm dataForm, RSMSet rsmSet) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException, NotLoggedInException {
MamQueryIQ mamQueryIQ = new MamQueryIQ(UUID.randomUUID().toString(), dataForm);
preparePageQuery(mamQueryIQ, rsmSet);
mamQueryIQ.setType(IQ.Type.set);
mamQueryIQ.addExtension(rsmSet);
return queryArchive(mamQueryIQ);
}
@ -373,20 +373,11 @@ public final class MamManager extends Manager {
public List<FormField> retrieveFormFields() throws NoResponseException, XMPPErrorException, NotConnectedException,
InterruptedException, NotLoggedInException {
String queryId = UUID.randomUUID().toString();
MamQueryIQ mamQueryIQ = prepareMamQueryIQGet(queryId);
return queryFormFields(mamQueryIQ);
}
MamQueryIQ mamQueryIq = new MamQueryIQ(queryId);
private MamQueryIQ prepareMamQueryIQSet(DataForm dataForm, String queryId) {
MamQueryIQ mamQueryIQ = new MamQueryIQ(queryId, dataForm);
mamQueryIQ.setType(IQ.Type.set);
return mamQueryIQ;
}
MamQueryIQ mamResponseQueryIq = connection().createPacketCollectorAndSend(mamQueryIq).nextResultOrThrow();
private MamQueryIQ prepareMamQueryIQGet(String queryId) {
MamQueryIQ mamQueryIQ = new MamQueryIQ(queryId, null);
mamQueryIQ.setType(IQ.Type.get);
return mamQueryIQ;
return mamResponseQueryIq.getDataForm().getFields();
}
private MamQueryResult queryArchive(MamQueryIQ mamQueryIq) throws NoResponseException, XMPPErrorException,
@ -435,23 +426,6 @@ public final class MamManager extends Manager {
}
}
private List<FormField> queryFormFields(MamQueryIQ mamQueryIq) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException, NotLoggedInException {
final XMPPConnection connection = connection();
MamQueryIQ mamResponseQueryIQ = null;
PacketCollector mamResponseQueryIQCollector = connection
.createPacketCollector(new IQReplyFilter(mamQueryIq, connection));
try {
connection.sendStanza(mamQueryIq);
mamResponseQueryIQ = mamResponseQueryIQCollector.nextResultOrThrow();
} finally {
mamResponseQueryIQCollector.cancel();
}
return mamResponseQueryIQ.getDataForm().getFields();
}
/**
* Returns true if Message Archive Management is supported by the server.
*
@ -466,7 +440,7 @@ public final class MamManager extends Manager {
return ServiceDiscoveryManager.getInstanceFor(connection()).serverSupportsFeature(MamElements.NAMESPACE);
}
private DataForm getNewMamForm() {
private static DataForm getNewMamForm() {
FormField field = new FormField(FormField.FORM_TYPE);
field.setType(FormField.Type.hidden);
field.addValue(MamElements.NAMESPACE);
@ -487,15 +461,10 @@ public final class MamManager extends Manager {
*/
public MamPrefsResult retrieveArchivingPreferences() throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException, NotLoggedInException {
MamPrefsIQ mamPrefIQ = prepareRetrievePreferencesStanza();
MamPrefsIQ mamPrefIQ = new MamPrefsIQ();
return queryMamPrefs(mamPrefIQ);
}
private MamPrefsIQ prepareRetrievePreferencesStanza() {
MamPrefsIQ mamPrefIQ = new MamPrefsIQ(Type.get, null, null, null);
return mamPrefIQ;
}
/**
* Update the preferences in the server.
*
@ -505,9 +474,8 @@ public final class MamManager extends Manager {
* @param neverJids
* is the list of JIDs that should never have messages to/from
* archived in the user's store
* @param defaultField
* can be "roster", "always", "never" (look at the XEP-0313
* documentation)
* @param defaultBehavior
* can be "roster", "always", "never" (see XEP-0313)
* @return the MAM preferences result
* @throws NoResponseException
* @throws XMPPErrorException
@ -515,18 +483,14 @@ public final class MamManager extends Manager {
* @throws InterruptedException
* @throws NotLoggedInException
*/
public MamPrefsResult updateArchivingPreferences(List<Jid> alwaysJids, List<Jid> neverJids, String defaultField)
public MamPrefsResult updateArchivingPreferences(List<Jid> alwaysJids, List<Jid> neverJids, DefaultBehavior defaultBehavior)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException,
NotLoggedInException {
MamPrefsIQ mamPrefIQ = prepareUpdatePreferencesStanza(alwaysJids, neverJids, defaultField);
Objects.requireNonNull(defaultBehavior, "Default behavior must be set");
MamPrefsIQ mamPrefIQ = new MamPrefsIQ(alwaysJids, neverJids, defaultBehavior);
return queryMamPrefs(mamPrefIQ);
}
private MamPrefsIQ prepareUpdatePreferencesStanza(List<Jid> alwaysJids, List<Jid> neverJids, String defaultField) {
MamPrefsIQ mamPrefIQ = new MamPrefsIQ(Type.set, alwaysJids, neverJids, defaultField);
return mamPrefIQ;
}
/**
* MAM preferences result class.
*
@ -544,16 +508,8 @@ public final class MamManager extends Manager {
private MamPrefsResult queryMamPrefs(MamPrefsIQ mamPrefsIQ) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException, NotLoggedInException {
final XMPPConnection connection = getAuthenticatedConnectionOrThrow();
MamPrefsIQ mamPrefsResultIQ = null;
PacketCollector prefsResultIQCollector = connection
.createPacketCollector(new IQReplyFilter(mamPrefsIQ, connection));
try {
connection.sendStanza(mamPrefsIQ);
mamPrefsResultIQ = prefsResultIQCollector.nextResultOrThrow();
} finally {
prefsResultIQCollector.cancel();
}
MamPrefsIQ mamPrefsResultIQ = connection.createPacketCollectorAndSend(mamPrefsIQ).nextResultOrThrow();
return new MamPrefsResult(mamPrefsResultIQ, DataForm.from(mamPrefsIQ));
}

2
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamElements.java
View file

@ -153,7 +153,7 @@ public class MamElements {
/**
* list of JIDs.
*/
private List<Jid> alwaysJids;
private final List<Jid> alwaysJids;
/**
* Always JID list element constructor.

79
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamPrefsIQ.java
View file

@ -33,6 +33,13 @@ import org.jxmpp.jid.Jid;
*/
public class MamPrefsIQ extends IQ {
public enum DefaultBehavior {
always,
never,
roster,
;
}
/**
* the preferences element.
*/
@ -43,65 +50,44 @@ public class MamPrefsIQ extends IQ {
*/
public static final String NAMESPACE = MamElements.NAMESPACE;
/**
* true if it is a request for update preferences.
*/
private boolean isUpdate;
/**
* true if it is a result preferences.
*/
private boolean isResult;
/**
* list of always.
*/
private List<Jid> alwaysJids;
private final List<Jid> alwaysJids;
/**
* list of never.
*/
private List<Jid> neverJids;
private final List<Jid> neverJids;
/**
* default field.
*/
private String defaultField;
private final DefaultBehavior defaultBehavior;
/**
* Construct a new MAM {@code <prefs/>} IQ retrieval request (IQ type 'get').
*/
public MamPrefsIQ() {
super(ELEMENT, NAMESPACE);
alwaysJids = null;
neverJids = null;
defaultBehavior = null;
}
/**
* MAM preferences IQ constructor.
*
* @param type
* @param alwaysJids
* @param neverJids
* @param defaultField
* @param defaultBehavior
*/
public MamPrefsIQ(Type type, List<Jid> alwaysJids, List<Jid> neverJids, String defaultField) {
public MamPrefsIQ(List<Jid> alwaysJids, List<Jid> neverJids, DefaultBehavior defaultBehavior) {
super(ELEMENT, NAMESPACE);
this.setType(type);
this.isUpdate = this.getType().equals(Type.set);
this.isResult = this.getType().equals(Type.result);
setType(Type.set);
this.alwaysJids = alwaysJids;
this.neverJids = neverJids;
this.defaultField = defaultField;
}
/**
* True if it is a request for update preferences.
*
* @return the update preferences boolean
*/
public boolean isUpdate() {
return isUpdate;
}
/**
* True if it is a result.
*
* @return the result preferences boolean
*/
public boolean isResult() {
return isUpdate;
this.defaultBehavior = defaultBehavior;
}
/**
@ -123,19 +109,24 @@ public class MamPrefsIQ extends IQ {
}
/**
* Get the default field.
* Get the default behavior.
*
* @return the default field
* @return the default behavior.
*/
public String getDefault() {
return defaultField;
public DefaultBehavior getDefault() {
return defaultBehavior;
}
@Override
protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
if (isUpdate || isResult) {
xml.attribute("default", defaultField);
if (getType().equals(IQ.Type.set) || getType().equals(IQ.Type.result)) {
xml.attribute("default", defaultBehavior);
}
if (alwaysJids == null && neverJids == null) {
xml.setEmptyElement();
return xml;
}
xml.rightAngleBracket();

1
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/element/MamQueryIQ.java
View file

@ -51,6 +51,7 @@ public class MamQueryIQ extends IQ {
*/
public MamQueryIQ(String queryId) {
this(queryId, null, null);
setType(IQ.Type.get);
}
/**

2
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/filter/MamResultFilter.java
View file

@ -31,7 +31,7 @@ import org.jivesoftware.smackx.mam.element.MamQueryIQ;
*/
public class MamResultFilter extends FlexibleStanzaTypeFilter<Message> {
private String queryId;
private final String queryId;
public MamResultFilter(MamQueryIQ mamQueryIQ) {
super(Message.class);

14
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamFinIQProvider.java
View file

@ -17,6 +17,7 @@
package org.jivesoftware.smackx.mam.provider;
import org.jivesoftware.smack.provider.IQProvider;
import org.jivesoftware.smack.util.ParserUtils;
import org.jivesoftware.smackx.mam.element.MamFinIQ;
import org.jivesoftware.smackx.rsm.packet.RSMSet;
import org.jivesoftware.smackx.rsm.provider.RSMSetProvider;
@ -35,20 +36,23 @@ public class MamFinIQProvider extends IQProvider<MamFinIQ> {
@Override
public MamFinIQ parse(XmlPullParser parser, int initialDepth) throws Exception {
String queryId = parser.getAttributeValue("", "queryid");
boolean complete = Boolean.parseBoolean(parser.getAttributeValue("", "complete"));
boolean stable = Boolean.parseBoolean(parser.getAttributeValue("", "stable"));
boolean complete = ParserUtils.getBooleanAttribute(parser, "complete", false);
boolean stable = ParserUtils.getBooleanAttribute(parser, "stable", true);
RSMSet rsmSet = null;
outerloop: while (true) {
int eventType = parser.next();
if (eventType == XmlPullParser.START_TAG) {
switch (eventType) {
case XmlPullParser.START_TAG:
if (parser.getName().equals(RSMSet.ELEMENT)) {
rsmSet = new RSMSetProvider().parse(parser);
rsmSet = RSMSetProvider.INSTANCE.parse(parser);
}
} else if (eventType == XmlPullParser.END_TAG) {
break;
case XmlPullParser.END_TAG:
if (parser.getDepth() == initialDepth) {
break outerloop;
}
break;
}
}

48
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamPrefsIQProvider.java
View file

@ -16,15 +16,17 @@
*/
package org.jivesoftware.smackx.mam.provider;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.jivesoftware.smack.packet.IQ.Type;
import org.jivesoftware.smack.provider.IQProvider;
import org.jivesoftware.smackx.mam.element.MamPrefsIQ;
import org.jivesoftware.smackx.mam.element.MamPrefsIQ.DefaultBehavior;
import org.jxmpp.jid.Jid;
import org.jxmpp.jid.impl.JidCreate;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* MAM Preferences IQ Provider class.
@ -37,9 +39,13 @@ import org.xmlpull.v1.XmlPullParser;
public class MamPrefsIQProvider extends IQProvider<MamPrefsIQ> {
@Override
public MamPrefsIQ parse(XmlPullParser parser, int initialDepth) throws Exception {
public MamPrefsIQ parse(XmlPullParser parser, int initialDepth) throws XmlPullParserException, IOException {
String iqType = parser.getAttributeValue("", "type");
String defaultField = parser.getAttributeValue("", "default");
String defaultBehaviorString = parser.getAttributeValue("", "default");
DefaultBehavior defaultBehavior = null;
if (defaultBehaviorString != null) {
defaultBehavior = DefaultBehavior.valueOf(defaultBehaviorString);
}
if (iqType == null) {
iqType = "result";
@ -49,40 +55,52 @@ public class MamPrefsIQProvider extends IQProvider<MamPrefsIQ> {
List<Jid> neverJids = null;
outerloop: while (true) {
int eventType = parser.next();
if (eventType == XmlPullParser.START_TAG) {
if (parser.getName().equals("always")) {
final int eventType = parser.next();
final String name = parser.getName();
switch (eventType) {
case XmlPullParser.START_TAG:
switch (name) {
case "always":
alwaysJids = iterateJids(parser);
}
if (parser.getName().equals("never")) {
break;
case "never":
neverJids = iterateJids(parser);
break;
}
} else if (eventType == XmlPullParser.END_TAG) {
break;
case XmlPullParser.END_TAG:
if (parser.getDepth() == initialDepth) {
break outerloop;
}
break;
}
}
return new MamPrefsIQ(Type.fromString(iqType), alwaysJids, neverJids, defaultField);
return new MamPrefsIQ(alwaysJids, neverJids, defaultBehavior);
}
private List<Jid> iterateJids(XmlPullParser parser) throws Exception {
private static List<Jid> iterateJids(XmlPullParser parser) throws XmlPullParserException, IOException {
List<Jid> jids = new ArrayList<>();
int initialDepth = parser.getDepth();
outerloop: while (true) {
int eventType = parser.next();
if (eventType == XmlPullParser.START_TAG) {
if (parser.getName().equals("jid")) {
final int eventType = parser.next();
final String name = parser.getName();
switch (eventType) {
case XmlPullParser.START_TAG:
switch (name) {
case "jid":
parser.next();
jids.add(JidCreate.from(parser.getText()));
break;
}
} else if (eventType == XmlPullParser.END_TAG) {
break;
case XmlPullParser.END_TAG:
if (parser.getDepth() == initialDepth) {
break outerloop;
}
break;
}
}

16
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamQueryIQProvider.java
View file

@ -39,16 +39,22 @@ public class MamQueryIQProvider extends IQProvider<MamQueryIQ> {
String node = parser.getAttributeValue("", "node");
outerloop: while (true) {
int eventType = parser.next();
final int eventType = parser.next();
final String name = parser.getName();
if (eventType == XmlPullParser.START_TAG) {
if (parser.getName().equals(DataForm.ELEMENT)) {
dataForm = new DataFormProvider().parse(parser);
switch (eventType) {
case XmlPullParser.START_TAG:
switch (name) {
case DataForm.ELEMENT:
dataForm = DataFormProvider.INSTANCE.parse(parser);
break;
}
} else if (eventType == XmlPullParser.END_TAG) {
break;
case XmlPullParser.END_TAG:
if (parser.getDepth() == initialDepth) {
break outerloop;
}
break;
}
}

16
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/provider/MamResultProvider.java
View file

@ -39,15 +39,21 @@ public class MamResultProvider extends ExtensionElementProvider<MamResultExtensi
String id = parser.getAttributeValue("", "id");
outerloop: while (true) {
int eventType = parser.next();
if (eventType == XmlPullParser.START_TAG) {
if (parser.getName().equals(Forwarded.ELEMENT)) {
forwarded = new ForwardedProvider().parse(parser);
final int eventType = parser.next();
final String name = parser.getName();
switch (eventType) {
case XmlPullParser.START_TAG:
switch (name) {
case Forwarded.ELEMENT:
forwarded = ForwardedProvider.INSTANCE.parse(parser);
break;
}
} else if (eventType == XmlPullParser.END_TAG) {
break;
case XmlPullParser.END_TAG:
if (parser.getDepth() == initialDepth) {
break outerloop;
}
break;
}
}