Маркеры чата (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