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