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