Маркери за чат (XEP-0333) в Smack

Има стар въпрос за това, но по това време Smack нямаше поддръжка за това XMPP разширение (XEP-0333). Освен това има въпрос в discourse.igniterealtime.org, но няма отговор и беше фокусиран да попита кога ще предоставят поддръжка за разширение xep-0333.

В момента се поддържа от Smack в Експериментални разширения на Smack и можете да намерите кода тук.

Търся примери, ръководство или как да използвам това разширение, без успех досега. Опитах се да ровя и в кода, надявайки се да намеря някакъв javadoc за това как да се използва, но също без успех.

Целта на този въпрос е получаване на кодов фрагмент за това как мога да го използвам в smack 4.x.x


person MiguelHincapieC    schedule 17.07.2018    source източник


Отговори (1)


актуализация: чакам преглед на PR кода, за да актуализирам следния код.

Отговарям на собствения си въпрос:
Както казах библиотеката Smack има експериментална поддръжка за XEP-0333, след като се опитах да го използвам с версия 4.2 и 4.3.0-rc1, открих, че XEP-0333 трябва да бъде подобрен, за да може да работи като IncomingChatMessageListener или ChatStateListener.

Освен това не можах да го накарам да работи само с помощта на OutgoingChatMessageListener и IncomingChatMessageListener интерфейси, защото вътре те проверяват дали <message> има <body> таг (защото правилата на протокола xmpp), но това правило не се прилага за XEP-0333:

Когато получателят изпраща маркер за чат, той ТРЯБВА да гарантира, че строфата на съобщението съдържа само дъщерния елемент на маркера за чат и по избор (когато е подходящо) дъщерен елемент на нишка. Естествено, междинните обекти могат да добавят други елементи на разширение към съобщението, когато маршрутизират или доставят съобщението за получаване, например елемент, както е посочено в Отложена доставка (XEP-0203).

Така че това, което направих, беше да подобря ChatMarkersManager клас, следвайки архитектурата и поведението от ChatManager (версия 2) и ChatStateManager.

Следният код е подобреният (все още имам нужда от обратна връзка от момчета от библиотеката на Smack), но работи:

public final class ChatMarkersManager extends Manager {

private static final Map<XMPPConnection, ChatMarkersManager> INSTANCES = new WeakHashMap<>();

// @FORMATTER:OFF
private static final StanzaFilter FILTER = new NotFilter(new StanzaExtensionFilter(ChatMarkersElements.NAMESPACE));
private static final StanzaFilter CHAT_STATE_FILTER = new NotFilter(new StanzaExtensionFilter(ChatStateManager.NAMESPACE));

private static final StanzaFilter MESSAGE_FILTER = new OrFilter(
        MessageTypeFilter.NORMAL_OR_CHAT,
        MessageTypeFilter.GROUPCHAT
);

private static final StanzaFilter INCOMING_MESSAGE_FILTER = new AndFilter(
        MESSAGE_FILTER,
        new StanzaExtensionFilter(ChatMarkersElements.NAMESPACE)
);
// @FORMATTER:ON

private final Set<IncomingChatMarkerMessageListener> incomingListeners = new CopyOnWriteArraySet<>();

private final AsyncButOrdered<Chat> asyncButOrdered = new AsyncButOrdered<>();

private ChatMarkersManager(XMPPConnection connection) {
    super(connection);
    connection.addStanzaInterceptor(new StanzaListener() {
        @Override
        public void processStanza(Stanza packet)
                throws
                SmackException.NotConnectedException,
                InterruptedException,
                SmackException.NotLoggedInException {
            Message message = (Message) packet;
            if (shouldDiscardMessage(message)) {
                return;
            }

            if (message.getBodies().isEmpty()) {
                return;
            }

            // if message already has a chatMarkerExtension, then do nothing,
            if (!FILTER.accept(message)) {
                return;
            }

            // otherwise add a markable extension,
            message.addExtension(new ChatMarkersElements.MarkableExtension());
        }
    }, MESSAGE_FILTER);

    connection.addSyncStanzaListener(new StanzaListener() {
        @Override
        public void processStanza(Stanza packet)
                throws
                SmackException.NotConnectedException,
                InterruptedException,
                SmackException.NotLoggedInException {
            final Message message = (Message) packet;
            if (shouldDiscardMessage(message)) {
                return;
            }

            EntityFullJid fullFrom = message.getFrom().asEntityFullJidIfPossible();
            EntityBareJid bareFrom = fullFrom.asEntityBareJid();
            final Chat chat = ChatManager.getInstanceFor(connection()).chatWith(bareFrom);

            List<IncomingChatMarkerMessageListener> listeners;
            synchronized (incomingListeners) {
                listeners = new ArrayList<>(incomingListeners.size());
                listeners.addAll(incomingListeners);
            }

            final List<IncomingChatMarkerMessageListener> finalListeners = listeners;
            asyncButOrdered.performAsyncButOrdered(chat, new Runnable() {
                @Override
                public void run() {
                    for (IncomingChatMarkerMessageListener listener : finalListeners) {
                        if (ChatMarkersElements.MarkableExtension.from(message) != null) {
                            listener.newMarkableMessage(message);
                        } else if (ChatMarkersElements.ReceivedExtension.from(message) != null) {
                            listener.newReceivedMessage(message);
                        } else if (ChatMarkersElements.DisplayedExtension.from(message) != null) {
                            listener.newDisplayedMessage(message);
                        } else if (ChatMarkersElements.AcknowledgedExtension.from(message) != null) {
                            listener.newAcknowledgedMessage(message);
                        }
                    }
                }
            });

        }
    }, INCOMING_MESSAGE_FILTER);

    ServiceDiscoveryManager.getInstanceFor(connection).addFeature(ChatMarkersElements.NAMESPACE);
}

/**
 * Get the singleton instance of ChatMarkersManager.
 *
 * @param connection
 * @return the instance of ChatMarkersManager
 */
public static synchronized ChatMarkersManager getInstanceFor(XMPPConnection connection) {
    ChatMarkersManager chatMarkersManager = INSTANCES.get(connection);

    if (chatMarkersManager == null) {
        chatMarkersManager = new ChatMarkersManager(connection);
        INSTANCES.put(connection, chatMarkersManager);
    }

    return chatMarkersManager;
}

/**
 * Register a IncomingChatMarkerMessageListener. That listener will be informed about new
 * incoming markable messages.
 *
 * @param listener IncomingChatMarkerMessageListener
 * @return true, if the listener was not registered before
 */
public boolean addIncomingChatMarkerMessageListener(IncomingChatMarkerMessageListener listener) {
    synchronized (incomingListeners) {
        return incomingListeners.add(listener);
    }
}

/**
 * Unregister a IncomingChatMarkerMessageListener.
 *
 * @param listener IncomingChatMarkerMessageListener
 * @return true, if the listener was registered before
 */
public boolean removeIncomingChatMarkerMessageListener(IncomingChatMarkerMessageListener listener) {
    synchronized (incomingListeners) {
        return incomingListeners.remove(listener);
    }
}

public void markMessageAsReceived(String id, Jid to, Jid from, String thread)
        throws
        SmackException.NotConnectedException,
        InterruptedException {
    Message message = createMessage(id, to, from, thread);
    message.addExtension(new ChatMarkersElements.ReceivedExtension(id));
    sendChatMarkerMessage(message);
}

public void markMessageAsDisplayed(String id, Jid to, Jid from, String thread)
        throws
        SmackException.NotConnectedException,
        InterruptedException {
    Message message = createMessage(id, to, from, thread);
    message.addExtension(new ChatMarkersElements.DisplayedExtension(id));
    sendChatMarkerMessage(message);
}

public void markMessageAsAcknowledged(String id, Jid to, Jid from, String thread)
        throws
        SmackException.NotConnectedException,
        InterruptedException {
    Message message = createMessage(id, to, from, thread);
    message.addExtension(new ChatMarkersElements.AcknowledgedExtension(id));
    sendChatMarkerMessage(message);
}

private Message createMessage(String id, Jid to, Jid from, String thread) {
    Message message = new Message();
    message.setStanzaId(id);
    message.setTo(to);
    message.setFrom(from);
    message.setThread(thread);
    return message;
}

private void sendChatMarkerMessage(Message message) throws SmackException.NotConnectedException, InterruptedException {
    connection().sendStanza(message);
}

/**
 * From XEP-0333, Protocol Format: The Chat Marker MUST have an 'id' which is the 'id' of the
 * message being marked.
 *
 * @param message to be analyzed.
 * @return true if the message contains a stanza Id.
 * @see <a href="http://xmpp.org/extensions/xep-0333.html">XEP-0333: Chat Markers</a>
 */
private boolean shouldDiscardMessage(Message message) {
    if (StringUtils.isNullOrEmpty(message.getStanzaId())) {
        return true;
    }

    if (!CHAT_STATE_FILTER.accept(message)) {
        ExtensionElement extension = message.getExtension(ChatStateManager.NAMESPACE);
        String chatStateElementName = extension.getElementName();

        ChatState state;
        try {
            state = ChatState.valueOf(chatStateElementName);
            return !(state == ChatState.active);
        } catch (Exception ex) {
            return true;
        }
    }

    return false;
}

/**
 * Returns true if Chat Markers is supported by the server.
 *
 * @return true if Chat Markers is supported by the server.
 * @throws SmackException.NotConnectedException
 * @throws XMPPException.XMPPErrorException
 * @throws SmackException.NoResponseException
 * @throws InterruptedException
 */
public boolean isSupportedByServer()
        throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException {
    return ServiceDiscoveryManager.getInstanceFor(connection())
            .serverSupportsFeature(ChatMarkersElements.NAMESPACE);
}

}

interface е просто:

public interface IncomingChatMarkerMessageListener {

void newMarkableMessage(Message message);
void newReceivedMessage(Message message);
void newDisplayedMessage(Message message);
void newAcknowledgedMessage(Message message);

}

В момента не използвам обекта Chat, така че не го предавам през интерфейса, но може да се добави лесно. Всъщност искам да имам възможност да се справям с Chat и MultiChat.

Това може да се използва заедно с XEP-0085, както предлага документът в 8.5 Взаимодействие със състояния на чат.

Както казах преди, работи, следвайки правилата на протокола, но имам някои въпроси, на които не мога да отговоря, и се надявам да получа обратна връзка от момчетата от библиотеката Smack :D

person MiguelHincapieC    schedule 24.07.2018
comment
Здравей, използваш ли този ChatMarkersManager? Всъщност се интересувам от използването на тази реализация, исках да знам вашите отзиви за това. Работи добре за вас? - person umerk44; 09.04.2020
comment
Здравей @umerk44! да, приложението използва доста подобна версия на тази, с някои подобрения. Можете да проверите PR в GitHub. - person MiguelHincapieC; 15.04.2020