PresenceParser.java

  1package eu.siacs.conversations.parser;
  2
  3import android.util.Log;
  4import androidx.annotation.NonNull;
  5import com.google.common.base.Strings;
  6import com.google.common.util.concurrent.FutureCallback;
  7import com.google.common.util.concurrent.Futures;
  8import com.google.common.util.concurrent.ListenableFuture;
  9import com.google.common.util.concurrent.MoreExecutors;
 10import eu.siacs.conversations.Config;
 11import eu.siacs.conversations.crypto.PgpEngine;
 12import eu.siacs.conversations.crypto.axolotl.AxolotlService;
 13import eu.siacs.conversations.entities.Account;
 14import eu.siacs.conversations.entities.Contact;
 15import eu.siacs.conversations.entities.Conversation;
 16import eu.siacs.conversations.entities.Message;
 17import eu.siacs.conversations.entities.MucOptions;
 18import eu.siacs.conversations.services.XmppConnectionService;
 19import eu.siacs.conversations.utils.XmppUri;
 20import eu.siacs.conversations.xml.Element;
 21import eu.siacs.conversations.xml.Namespace;
 22import eu.siacs.conversations.xmpp.Jid;
 23import eu.siacs.conversations.xmpp.XmppConnection;
 24import eu.siacs.conversations.xmpp.manager.AvatarManager;
 25import eu.siacs.conversations.xmpp.manager.DiscoManager;
 26import eu.siacs.conversations.xmpp.manager.MultiUserChatManager;
 27import eu.siacs.conversations.xmpp.manager.PresenceManager;
 28import eu.siacs.conversations.xmpp.manager.RosterManager;
 29import im.conversations.android.xmpp.Entity;
 30import im.conversations.android.xmpp.model.muc.user.MucUser;
 31import im.conversations.android.xmpp.model.occupant.OccupantId;
 32import im.conversations.android.xmpp.model.vcard.update.VCardUpdate;
 33import java.util.ArrayList;
 34import java.util.List;
 35import java.util.concurrent.TimeoutException;
 36import java.util.function.Consumer;
 37import org.openintents.openpgp.util.OpenPgpUtils;
 38
 39public class PresenceParser extends AbstractParser
 40        implements Consumer<im.conversations.android.xmpp.model.stanza.Presence> {
 41
 42    public PresenceParser(final XmppConnectionService service, final XmppConnection connection) {
 43        super(service, connection);
 44    }
 45
 46    public void parseConferencePresence(
 47            final im.conversations.android.xmpp.model.stanza.Presence packet) {
 48        final var account = getAccount();
 49        final Conversation conversation =
 50                packet.getFrom() == null
 51                        ? null
 52                        : mXmppConnectionService.find(account, packet.getFrom().asBareJid());
 53        if (conversation == null) {
 54            Log.d(Config.LOGTAG, "conversation not found for parsing conference presence");
 55            return;
 56        }
 57        final MucOptions mucOptions = conversation.getMucOptions();
 58        boolean before = mucOptions.online();
 59        int count = mucOptions.getUserCount();
 60        final List<MucOptions.User> tileUserBefore = mucOptions.getUsers(5);
 61        processConferencePresence(packet, conversation);
 62        final List<MucOptions.User> tileUserAfter = mucOptions.getUsers(5);
 63        if (Strings.isNullOrEmpty(mucOptions.getAvatar())
 64                && !tileUserAfter.equals(tileUserBefore)) {
 65            mXmppConnectionService.getAvatarService().clear(mucOptions);
 66        }
 67        if (before != mucOptions.online()
 68                || (mucOptions.online() && count != mucOptions.getUserCount())) {
 69            mXmppConnectionService.updateConversationUi();
 70        } else if (mucOptions.online()) {
 71            mXmppConnectionService.updateMucRosterUi();
 72        }
 73    }
 74
 75    private void processConferencePresence(
 76            final im.conversations.android.xmpp.model.stanza.Presence packet,
 77            Conversation conversation) {
 78        final Account account = conversation.getAccount();
 79        final MucOptions mucOptions = conversation.getMucOptions();
 80        final Jid jid = conversation.getAccount().getJid();
 81        final Jid from = packet.getFrom();
 82        if (!from.isBareJid()) {
 83            final String type = packet.getAttribute("type");
 84            final var x = packet.getExtension(MucUser.class);
 85            final var vCardUpdate = packet.getExtension(VCardUpdate.class);
 86            final Element nick = packet.findChild("nick", Namespace.NICK);
 87            Element hats = packet.findChild("hats", "urn:xmpp:hats:0");
 88            if (hats == null) {
 89                hats = packet.findChild("hats", "xmpp:prosody.im/protocol/hats:1");
 90            }
 91            if (hats == null) hats = new Element("hats", "urn:xmpp:hats:0");
 92            final var occupant = packet.getOnlyExtension(OccupantId.class);
 93            final String occupantId =
 94                                mucOptions.occupantId() && occupant != null
 95                                        ? occupant.getId()
 96                                        : null;
 97            final List<String> codes = getStatusCodes(x);
 98            if (type == null) {
 99                if (x != null) {
100                    final var item = x.getItem();
101                    if (item != null && !from.isBareJid()) {
102                        mucOptions.setError(MucOptions.Error.NONE);
103                        final var user = MultiUserChatManager.itemToUser(conversation, item, from, occupantId, nick == null ? null : nick.getContent(), hats);
104                        user.setOccupantId(occupantId);
105                        if (codes.contains(MucOptions.STATUS_CODE_SELF_PRESENCE)
106                                || (codes.contains(MucOptions.STATUS_CODE_ROOM_CREATED)
107                                        && jid.equals(
108                                                Jid.Invalid.getNullForInvalid(
109                                                        item.getAttributeAsJid("jid"))))) {
110                            Log.d(
111                                    Config.LOGTAG,
112                                    account.getJid().asBareJid()
113                                            + ": got self-presence from "
114                                            + user.getFullJid()
115                                            + ". occupant-id="
116                                            + occupantId);
117                            if (mucOptions.setOnline()) {
118                                mXmppConnectionService.getAvatarService().clear(mucOptions);
119                            }
120                            final var current = mucOptions.getSelf().getFullJid();
121                            if (mucOptions.setSelf(user)) {
122                                Log.d(Config.LOGTAG,"role or affiliation changed");
123                                mXmppConnectionService.databaseBackend.updateConversation(conversation);
124                            }
125                            final var modified =
126                                    current == null || !current.equals(user.getFullJid());
127                            mXmppConnectionService.persistSelfNick(user, modified);
128                            invokeRenameListener(mucOptions, true);
129                        }
130                        boolean isNew = mucOptions.updateUser(user);
131                        final AxolotlService axolotlService =
132                                conversation.getAccount().getAxolotlService();
133                        Contact contact = user.getContact();
134                        if (isNew
135                                && user.getRealJid() != null
136                                && mucOptions.isPrivateAndNonAnonymous()
137                                && (contact == null || !contact.mutualPresenceSubscription())
138                                && axolotlService.hasEmptyDeviceList(user.getRealJid())) {
139                            axolotlService.fetchDeviceIds(user.getRealJid());
140                        }
141                        if (codes.contains(MucOptions.STATUS_CODE_ROOM_CREATED)
142                                && mucOptions.autoPushConfiguration()) {
143                            final var address = mucOptions.getConversation().getJid().asBareJid();
144                            Log.d(
145                                    Config.LOGTAG,
146                                    account.getJid().asBareJid()
147                                            + ": room '"
148                                            + address
149                                            + "' created. pushing default configuration");
150                            getManager(MultiUserChatManager.class)
151                                    .pushConfiguration(
152                                            conversation,
153                                            MultiUserChatManager.defaultChannelConfiguration());
154                        }
155                        if (mXmppConnectionService.getPgpEngine() != null) {
156                            Element signed = packet.findChild("x", "jabber:x:signed");
157                            if (signed != null) {
158                                Element status = packet.findChild("status");
159                                String msg = status == null ? "" : status.getContent();
160                                long keyId =
161                                        mXmppConnectionService
162                                                .getPgpEngine()
163                                                .fetchKeyId(
164                                                        mucOptions.getAccount(),
165                                                        msg,
166                                                        signed.getContent());
167                                if (keyId != 0) {
168                                    user.setPgpKeyId(keyId);
169                                }
170                            }
171                        }
172                        if (vCardUpdate != null) {
173                            getManager(AvatarManager.class).handleVCardUpdate(from, vCardUpdate);
174                        }
175                    }
176                }
177            } else if (type.equals("unavailable")) {
178                final boolean fullJidMatches = from.equals(mucOptions.getSelf().getFullJid());
179                if (x.hasChild("destroy") && fullJidMatches) {
180                    Element destroy = x.findChild("destroy");
181                    final Jid alternate =
182                            destroy == null
183                                    ? null
184                                    : Jid.Invalid.getNullForInvalid(
185                                            destroy.getAttributeAsJid("jid"));
186                    mucOptions.setError(MucOptions.Error.DESTROYED);
187                    if (alternate != null) {
188                        Log.d(
189                                Config.LOGTAG,
190                                account.getJid().asBareJid()
191                                        + ": muc destroyed. alternate location "
192                                        + alternate);
193                    }
194                } else if (codes.contains(MucOptions.STATUS_CODE_SHUTDOWN) && fullJidMatches) {
195                    mucOptions.setError(MucOptions.Error.SHUTDOWN);
196                } else if (codes.contains(MucOptions.STATUS_CODE_SELF_PRESENCE)) {
197                    if (codes.contains(MucOptions.STATUS_CODE_TECHNICAL_REASONS)) {
198                        final boolean wasOnline = mucOptions.online();
199                        mucOptions.setError(MucOptions.Error.TECHNICAL_PROBLEMS);
200                        Log.d(
201                                Config.LOGTAG,
202                                account.getJid().asBareJid()
203                                        + ": received status code 333 in room "
204                                        + mucOptions.getConversation().getJid().asBareJid()
205                                        + " online="
206                                        + wasOnline);
207                        if (wasOnline) {
208                            getManager(MultiUserChatManager.class).pingAndRejoin(conversation);
209                        }
210                    } else if (codes.contains(MucOptions.STATUS_CODE_KICKED)) {
211                        mucOptions.setError(MucOptions.Error.KICKED);
212                    } else if (codes.contains(MucOptions.STATUS_CODE_BANNED)) {
213                        mucOptions.setError(MucOptions.Error.BANNED);
214                    } else if (codes.contains(MucOptions.STATUS_CODE_LOST_MEMBERSHIP)) {
215                        mucOptions.setError(MucOptions.Error.MEMBERS_ONLY);
216                    } else if (codes.contains(MucOptions.STATUS_CODE_AFFILIATION_CHANGE)) {
217                        mucOptions.setError(MucOptions.Error.MEMBERS_ONLY);
218                    } else if (codes.contains(MucOptions.STATUS_CODE_SHUTDOWN)) {
219                        mucOptions.setError(MucOptions.Error.SHUTDOWN);
220                    } else if (!codes.contains(MucOptions.STATUS_CODE_CHANGED_NICK)) {
221                        mucOptions.setError(MucOptions.Error.UNKNOWN);
222                        Log.d(Config.LOGTAG, "unknown error in conference: " + packet);
223                    }
224                } else if (!from.isBareJid()) {
225                    final var item = x.getItem();
226                    if (item != null) {
227                        mucOptions.updateUser(
228                                MultiUserChatManager.itemToUser(conversation, item, from, occupantId, nick == null ? null : nick.getContent(), hats));
229                    }
230                    MucOptions.User user = mucOptions.deleteUser(from);
231                    if (user != null && occupantId == null) {
232                        mXmppConnectionService.getAvatarService().clear(user);
233                    }
234                }
235            } else if (type.equals("error")) {
236                final Element error = packet.findChild("error");
237                if (error == null) {
238                    return;
239                }
240                if (error.hasChild("conflict")) {
241                    if (mucOptions.online()) {
242                        invokeRenameListener(mucOptions, false);
243                    } else {
244                        mucOptions.setError(MucOptions.Error.NICK_IN_USE);
245                    }
246                } else if (error.hasChild("not-authorized")) {
247                    mucOptions.setError(MucOptions.Error.PASSWORD_REQUIRED);
248                } else if (error.hasChild("forbidden")) {
249                    mucOptions.setError(MucOptions.Error.BANNED);
250                } else if (error.hasChild("registration-required")) {
251                    mucOptions.setError(MucOptions.Error.MEMBERS_ONLY);
252                } else if (error.hasChild("resource-constraint")) {
253                    mucOptions.setError(MucOptions.Error.RESOURCE_CONSTRAINT);
254                } else if (error.hasChild("remote-server-timeout")) {
255                    mucOptions.setError(MucOptions.Error.REMOTE_SERVER_TIMEOUT);
256                } else if (error.hasChild("gone")) {
257                    final String gone = error.findChildContent("gone");
258                    final Jid alternate;
259                    if (gone != null) {
260                        final XmppUri xmppUri = new XmppUri(gone);
261                        if (xmppUri.isValidJid()) {
262                            alternate = xmppUri.getJid();
263                        } else {
264                            alternate = null;
265                        }
266                    } else {
267                        alternate = null;
268                    }
269                    mucOptions.setError(MucOptions.Error.DESTROYED);
270                    if (alternate != null) {
271                        Log.d(
272                                Config.LOGTAG,
273                                conversation.getAccount().getJid().asBareJid()
274                                        + ": muc destroyed. alternate location "
275                                        + alternate);
276                    }
277                } else {
278                    final String text = error.findChildContent("text");
279                    if (text != null && text.contains("attribute 'to'")) {
280                        if (mucOptions.online()) {
281                            invokeRenameListener(mucOptions, false);
282                        } else {
283                            mucOptions.setError(MucOptions.Error.INVALID_NICK);
284                        }
285                    } else {
286                        mucOptions.setError(MucOptions.Error.UNKNOWN);
287                        Log.d(Config.LOGTAG, "unknown error in conference: " + packet);
288                    }
289                }
290            }
291        }
292    }
293
294    private static void invokeRenameListener(final MucOptions options, boolean success) {
295        if (options.onRenameListener != null) {
296            if (success) {
297                options.onRenameListener.onSuccess();
298            } else {
299                options.onRenameListener.onFailure();
300            }
301            options.onRenameListener = null;
302        }
303    }
304
305    private static List<String> getStatusCodes(Element x) {
306        List<String> codes = new ArrayList<>();
307        if (x != null) {
308            for (Element child : x.getChildren()) {
309                if (child.getName().equals("status")) {
310                    String code = child.getAttribute("code");
311                    if (code != null) {
312                        codes.add(code);
313                    }
314                }
315            }
316        }
317        return codes;
318    }
319
320    private void parseContactPresence(
321            final im.conversations.android.xmpp.model.stanza.Presence packet) {
322        final var account = getAccount();
323        final Jid from = packet.getFrom();
324        if (from == null || from.equals(account.getJid())) {
325            return;
326        }
327        final String type = packet.getAttribute("type");
328        final Contact contact = account.getRoster().getContact(from);
329        if (type == null) {
330            final String resource = from.isBareJid() ? "" : from.getResource();
331
332            if (mXmppConnectionService.isMuc(account, from)) {
333                return;
334            }
335
336            final int sizeBefore = contact.getPresences().size();
337
338            contact.updatePresence(resource, packet);
339
340            final var nodeHash = packet.getCapabilities();
341            if (nodeHash != null) {
342                final var discoFuture =
343                        this.getManager(DiscoManager.class)
344                                .infoOrCache(Entity.presence(from), nodeHash.node, nodeHash.hash);
345
346                logDiscoFailure(from, discoFuture);
347            }
348
349            final Element idle = packet.findChild("idle", Namespace.IDLE);
350            if (idle != null) {
351                try {
352                    final String since = idle.getAttribute("since");
353                    contact.setLastseen(AbstractParser.parseTimestamp(since));
354                    contact.flagInactive();
355                } catch (Throwable throwable) {
356                    if (contact.setLastseen(AbstractParser.parseTimestamp(packet))) {
357                        contact.flagActive();
358                    }
359                }
360            } else {
361                if (contact.setLastseen(AbstractParser.parseTimestamp(packet))) {
362                    contact.flagActive();
363                }
364            }
365
366            final PgpEngine pgp = mXmppConnectionService.getPgpEngine();
367            final Element x = packet.findChild("x", "jabber:x:signed");
368            if (pgp != null && x != null) {
369                final String status = packet.findChildContent("status");
370                final long keyId = pgp.fetchKeyId(account, status, x.getContent());
371                if (keyId != 0 && contact.setPgpKeyId(keyId)) {
372                    Log.d(
373                            Config.LOGTAG,
374                            account.getJid().asBareJid()
375                                    + ": found OpenPGP key id for "
376                                    + contact.getJid()
377                                    + " "
378                                    + OpenPgpUtils.convertKeyIdToHex(keyId));
379                    this.connection.getManager(RosterManager.class).writeToDatabaseAsync();
380                }
381            }
382            boolean online = sizeBefore < contact.getPresences().size();
383            mXmppConnectionService.onContactStatusChanged.onContactStatusChanged(contact, online);
384        } else if (type.equals("unavailable")) {
385            if (contact.setLastseen(AbstractParser.parseTimestamp(packet, 0L, true))) {
386                contact.flagInactive();
387            }
388            getManager(DiscoManager.class).clear(from);
389            if (from.isBareJid()) {
390                contact.clearPresences();
391            } else {
392                contact.removePresence(from.getResource());
393            }
394            if (contact.getShownStatus()
395                    == im.conversations.android.xmpp.model.stanza.Presence.Availability.OFFLINE) {
396                contact.flagInactive();
397            }
398            mXmppConnectionService.onContactStatusChanged.onContactStatusChanged(contact, false);
399        } else if (type.equals("subscribe")) {
400            if (contact.isBlocked()) {
401                Log.d(
402                        Config.LOGTAG,
403                        account.getJid().asBareJid()
404                                + ": ignoring 'subscribe' presence from blocked "
405                                + from);
406                return;
407            }
408            if (contact.setPresenceName(packet.findChildContent("nick", Namespace.NICK))) {
409                this.getManager(RosterManager.class).writeToDatabaseAsync();
410                mXmppConnectionService.getAvatarService().clear(contact);
411            }
412            if (contact.getOption(Contact.Options.PREEMPTIVE_GRANT)) {
413                connection
414                        .getManager(PresenceManager.class)
415                        .subscribed(contact.getJid().asBareJid());
416            } else {
417                contact.setOption(Contact.Options.PENDING_SUBSCRIPTION_REQUEST);
418                final Conversation conversation =
419                        mXmppConnectionService.findOrCreateConversation(
420                                account, contact.getJid().asBareJid(), false, false);
421                final String statusMessage = packet.findChildContent("status");
422                if (statusMessage != null
423                        && !statusMessage.isEmpty()
424                        && conversation.countMessages() == 0) {
425                    conversation.add(
426                            new Message(
427                                    conversation,
428                                    statusMessage,
429                                    Message.ENCRYPTION_NONE,
430                                    Message.STATUS_RECEIVED));
431                }
432            }
433        }
434        mXmppConnectionService.updateRosterUi(XmppConnectionService.UpdateRosterReason.PRESENCE, contact);
435    }
436
437    private static void logDiscoFailure(final Jid from, ListenableFuture<Void> discoFuture) {
438        Futures.addCallback(
439                discoFuture,
440                new FutureCallback<>() {
441                    @Override
442                    public void onSuccess(Void result) {}
443
444                    @Override
445                    public void onFailure(@NonNull Throwable throwable) {
446                        if (throwable instanceof TimeoutException) {
447                            return;
448                        }
449                        Log.d(Config.LOGTAG, "could not retrieve disco from " + from, throwable);
450                    }
451                },
452                MoreExecutors.directExecutor());
453    }
454
455    @Override
456    public void accept(final im.conversations.android.xmpp.model.stanza.Presence packet) {
457        if (packet.hasChild("x", Namespace.MUC_USER)) {
458            this.parseConferencePresence(packet);
459        } else if (packet.hasChild("x", "http://jabber.org/protocol/muc")) {
460            this.parseConferencePresence(packet);
461        } else if ("error".equals(packet.getAttribute("type"))
462                && mXmppConnectionService.isMuc(getAccount(), packet.getFrom())) {
463            this.parseConferencePresence(packet);
464        } else {
465            this.parseContactPresence(packet);
466        }
467    }
468}