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
172                                // TODO don’t do that. This will just overwrite (better) PEP avatars
173
174                                if (user.getRealJid() != null) {
175                                    final Contact c =
176                                            conversation
177                                                    .getAccount()
178                                                    .getRoster()
179                                                    .getContact(user.getRealJid());
180                                    if (c.setAvatar(avatar.sha1sum)) {
181                                        connection
182                                                .getManager(RosterManager.class)
183                                                .writeToDatabaseAsync();
184                                        mXmppConnectionService.getAvatarService().clear(c);
185                                    }
186                                    mXmppConnectionService.updateRosterUi();
187                                }
188                            } else if (mXmppConnectionService.isDataSaverDisabled()) {
189                                mXmppConnectionService.fetchAvatar(mucOptions.getAccount(), avatar);
190                            }
191                        }
192                    }
193                }
194            } else if (type.equals("unavailable")) {
195                final boolean fullJidMatches = from.equals(mucOptions.getSelf().getFullJid());
196                if (x.hasChild("destroy") && fullJidMatches) {
197                    Element destroy = x.findChild("destroy");
198                    final Jid alternate =
199                            destroy == null
200                                    ? null
201                                    : Jid.Invalid.getNullForInvalid(
202                                            destroy.getAttributeAsJid("jid"));
203                    mucOptions.setError(MucOptions.Error.DESTROYED);
204                    if (alternate != null) {
205                        Log.d(
206                                Config.LOGTAG,
207                                account.getJid().asBareJid()
208                                        + ": muc destroyed. alternate location "
209                                        + alternate);
210                    }
211                } else if (codes.contains(MucOptions.STATUS_CODE_SHUTDOWN) && fullJidMatches) {
212                    mucOptions.setError(MucOptions.Error.SHUTDOWN);
213                } else if (codes.contains(MucOptions.STATUS_CODE_SELF_PRESENCE)) {
214                    if (codes.contains(MucOptions.STATUS_CODE_TECHNICAL_REASONS)) {
215                        final boolean wasOnline = mucOptions.online();
216                        mucOptions.setError(MucOptions.Error.TECHNICAL_PROBLEMS);
217                        Log.d(
218                                Config.LOGTAG,
219                                account.getJid().asBareJid()
220                                        + ": received status code 333 in room "
221                                        + mucOptions.getConversation().getJid().asBareJid()
222                                        + " online="
223                                        + wasOnline);
224                        if (wasOnline) {
225                            mXmppConnectionService.mucSelfPingAndRejoin(conversation);
226                        }
227                    } else if (codes.contains(MucOptions.STATUS_CODE_KICKED)) {
228                        mucOptions.setError(MucOptions.Error.KICKED);
229                    } else if (codes.contains(MucOptions.STATUS_CODE_BANNED)) {
230                        mucOptions.setError(MucOptions.Error.BANNED);
231                    } else if (codes.contains(MucOptions.STATUS_CODE_LOST_MEMBERSHIP)) {
232                        mucOptions.setError(MucOptions.Error.MEMBERS_ONLY);
233                    } else if (codes.contains(MucOptions.STATUS_CODE_AFFILIATION_CHANGE)) {
234                        mucOptions.setError(MucOptions.Error.MEMBERS_ONLY);
235                    } else if (codes.contains(MucOptions.STATUS_CODE_SHUTDOWN)) {
236                        mucOptions.setError(MucOptions.Error.SHUTDOWN);
237                    } else if (!codes.contains(MucOptions.STATUS_CODE_CHANGED_NICK)) {
238                        mucOptions.setError(MucOptions.Error.UNKNOWN);
239                        Log.d(Config.LOGTAG, "unknown error in conference: " + packet);
240                    }
241                } else if (!from.isBareJid()) {
242                    Element item = x.findChild("item");
243                    if (item != null) {
244                        mucOptions.updateUser(parseItem(conversation, item, from));
245                    }
246                    MucOptions.User user = mucOptions.deleteUser(from);
247                    if (user != null) {
248                        mXmppConnectionService.getAvatarService().clear(user);
249                    }
250                }
251            } else if (type.equals("error")) {
252                final Element error = packet.findChild("error");
253                if (error == null) {
254                    return;
255                }
256                if (error.hasChild("conflict")) {
257                    if (mucOptions.online()) {
258                        invokeRenameListener(mucOptions, false);
259                    } else {
260                        mucOptions.setError(MucOptions.Error.NICK_IN_USE);
261                    }
262                } else if (error.hasChild("not-authorized")) {
263                    mucOptions.setError(MucOptions.Error.PASSWORD_REQUIRED);
264                } else if (error.hasChild("forbidden")) {
265                    mucOptions.setError(MucOptions.Error.BANNED);
266                } else if (error.hasChild("registration-required")) {
267                    mucOptions.setError(MucOptions.Error.MEMBERS_ONLY);
268                } else if (error.hasChild("resource-constraint")) {
269                    mucOptions.setError(MucOptions.Error.RESOURCE_CONSTRAINT);
270                } else if (error.hasChild("remote-server-timeout")) {
271                    mucOptions.setError(MucOptions.Error.REMOTE_SERVER_TIMEOUT);
272                } else if (error.hasChild("gone")) {
273                    final String gone = error.findChildContent("gone");
274                    final Jid alternate;
275                    if (gone != null) {
276                        final XmppUri xmppUri = new XmppUri(gone);
277                        if (xmppUri.isValidJid()) {
278                            alternate = xmppUri.getJid();
279                        } else {
280                            alternate = null;
281                        }
282                    } else {
283                        alternate = null;
284                    }
285                    mucOptions.setError(MucOptions.Error.DESTROYED);
286                    if (alternate != null) {
287                        Log.d(
288                                Config.LOGTAG,
289                                conversation.getAccount().getJid().asBareJid()
290                                        + ": muc destroyed. alternate location "
291                                        + alternate);
292                    }
293                } else {
294                    final String text = error.findChildContent("text");
295                    if (text != null && text.contains("attribute 'to'")) {
296                        if (mucOptions.online()) {
297                            invokeRenameListener(mucOptions, false);
298                        } else {
299                            mucOptions.setError(MucOptions.Error.INVALID_NICK);
300                        }
301                    } else {
302                        mucOptions.setError(MucOptions.Error.UNKNOWN);
303                        Log.d(Config.LOGTAG, "unknown error in conference: " + packet);
304                    }
305                }
306            }
307        }
308    }
309
310    private static void invokeRenameListener(final MucOptions options, boolean success) {
311        if (options.onRenameListener != null) {
312            if (success) {
313                options.onRenameListener.onSuccess();
314            } else {
315                options.onRenameListener.onFailure();
316            }
317            options.onRenameListener = null;
318        }
319    }
320
321    private static List<String> getStatusCodes(Element x) {
322        List<String> codes = new ArrayList<>();
323        if (x != null) {
324            for (Element child : x.getChildren()) {
325                if (child.getName().equals("status")) {
326                    String code = child.getAttribute("code");
327                    if (code != null) {
328                        codes.add(code);
329                    }
330                }
331            }
332        }
333        return codes;
334    }
335
336    private void parseContactPresence(
337            final im.conversations.android.xmpp.model.stanza.Presence packet) {
338        final var account = getAccount();
339        final PresenceGenerator mPresenceGenerator = mXmppConnectionService.getPresenceGenerator();
340        final Jid from = packet.getFrom();
341        if (from == null || from.equals(account.getJid())) {
342            return;
343        }
344        final String type = packet.getAttribute("type");
345        final Contact contact = account.getRoster().getContact(from);
346        if (type == null) {
347            final String resource = from.isBareJid() ? "" : from.getResource();
348
349            // TODO simply don’t parse avatars for contacts at all. Only if presence is bare and a
350            // MUC
351
352            final Avatar avatar =
353                    Avatar.parsePresence(packet.findChild("x", "vcard-temp:x:update"));
354            if (avatar != null && (!contact.isSelf() || account.getAvatar() == null)) {
355                avatar.owner = from.asBareJid();
356                if (mXmppConnectionService.getFileBackend().isAvatarCached(avatar)) {
357                    if (avatar.owner.equals(account.getJid().asBareJid())) {
358                        account.setAvatar(avatar.getFilename());
359                        mXmppConnectionService.databaseBackend.updateAccount(account);
360                        mXmppConnectionService.getAvatarService().clear(account);
361                        mXmppConnectionService.updateConversationUi();
362                        mXmppConnectionService.updateAccountUi();
363                    } else {
364                        if (contact.setAvatar(avatar.sha1sum)) {
365                            connection.getManager(RosterManager.class).writeToDatabaseAsync();
366                            mXmppConnectionService.getAvatarService().clear(contact);
367                            mXmppConnectionService.updateConversationUi();
368                            mXmppConnectionService.updateRosterUi();
369                        }
370                    }
371                } else if (mXmppConnectionService.isDataSaverDisabled()) {
372                    mXmppConnectionService.fetchAvatar(account, avatar);
373                }
374            }
375
376            if (mXmppConnectionService.isMuc(account, from)) {
377                return;
378            }
379
380            final int sizeBefore = contact.getPresences().size();
381
382            contact.updatePresence(resource, packet);
383
384            final var nodeHash = packet.getCapabilities();
385            if (nodeHash != null) {
386                final var discoFuture =
387                        this.getManager(DiscoManager.class)
388                                .infoOrCache(Entity.presence(from), nodeHash.node, nodeHash.hash);
389
390                logDiscoFailure(from, discoFuture);
391            }
392
393            final Element idle = packet.findChild("idle", Namespace.IDLE);
394            if (idle != null) {
395                try {
396                    final String since = idle.getAttribute("since");
397                    contact.setLastseen(AbstractParser.parseTimestamp(since));
398                    contact.flagInactive();
399                } catch (Throwable throwable) {
400                    if (contact.setLastseen(AbstractParser.parseTimestamp(packet))) {
401                        contact.flagActive();
402                    }
403                }
404            } else {
405                if (contact.setLastseen(AbstractParser.parseTimestamp(packet))) {
406                    contact.flagActive();
407                }
408            }
409
410            final PgpEngine pgp = mXmppConnectionService.getPgpEngine();
411            final Element x = packet.findChild("x", "jabber:x:signed");
412            if (pgp != null && x != null) {
413                final String status = packet.findChildContent("status");
414                final long keyId = pgp.fetchKeyId(account, status, x.getContent());
415                if (keyId != 0 && contact.setPgpKeyId(keyId)) {
416                    Log.d(
417                            Config.LOGTAG,
418                            account.getJid().asBareJid()
419                                    + ": found OpenPGP key id for "
420                                    + contact.getJid()
421                                    + " "
422                                    + OpenPgpUtils.convertKeyIdToHex(keyId));
423                    this.connection.getManager(RosterManager.class).writeToDatabaseAsync();
424                }
425            }
426            boolean online = sizeBefore < contact.getPresences().size();
427            mXmppConnectionService.onContactStatusChanged.onContactStatusChanged(contact, online);
428        } else if (type.equals("unavailable")) {
429            if (contact.setLastseen(AbstractParser.parseTimestamp(packet, 0L, true))) {
430                contact.flagInactive();
431            }
432            getManager(DiscoManager.class).clear(from);
433            if (from.isBareJid()) {
434                contact.clearPresences();
435            } else {
436                contact.removePresence(from.getResource());
437            }
438            if (contact.getShownStatus()
439                    == im.conversations.android.xmpp.model.stanza.Presence.Availability.OFFLINE) {
440                contact.flagInactive();
441            }
442            mXmppConnectionService.onContactStatusChanged.onContactStatusChanged(contact, false);
443        } else if (type.equals("subscribe")) {
444            if (contact.isBlocked()) {
445                Log.d(
446                        Config.LOGTAG,
447                        account.getJid().asBareJid()
448                                + ": ignoring 'subscribe' presence from blocked "
449                                + from);
450                return;
451            }
452            if (contact.setPresenceName(packet.findChildContent("nick", Namespace.NICK))) {
453                this.getManager(RosterManager.class).writeToDatabaseAsync();
454                mXmppConnectionService.getAvatarService().clear(contact);
455            }
456            if (contact.getOption(Contact.Options.PREEMPTIVE_GRANT)) {
457                connection
458                        .getManager(PresenceManager.class)
459                        .subscribed(contact.getJid().asBareJid());
460            } else {
461                contact.setOption(Contact.Options.PENDING_SUBSCRIPTION_REQUEST);
462                final Conversation conversation =
463                        mXmppConnectionService.findOrCreateConversation(
464                                account, contact.getJid().asBareJid(), false, false);
465                final String statusMessage = packet.findChildContent("status");
466                if (statusMessage != null
467                        && !statusMessage.isEmpty()
468                        && conversation.countMessages() == 0) {
469                    conversation.add(
470                            new Message(
471                                    conversation,
472                                    statusMessage,
473                                    Message.ENCRYPTION_NONE,
474                                    Message.STATUS_RECEIVED));
475                }
476            }
477        }
478        mXmppConnectionService.updateRosterUi();
479    }
480
481    private static void logDiscoFailure(final Jid from, ListenableFuture<Void> discoFuture) {
482        Futures.addCallback(
483                discoFuture,
484                new FutureCallback<>() {
485                    @Override
486                    public void onSuccess(Void result) {}
487
488                    @Override
489                    public void onFailure(@NonNull Throwable throwable) {
490                        if (throwable instanceof TimeoutException) {
491                            return;
492                        }
493                        Log.d(Config.LOGTAG, "could not retrieve disco from " + from, throwable);
494                    }
495                },
496                MoreExecutors.directExecutor());
497    }
498
499    @Override
500    public void accept(final im.conversations.android.xmpp.model.stanza.Presence packet) {
501        if (packet.hasChild("x", Namespace.MUC_USER)) {
502            this.parseConferencePresence(packet);
503        } else if (packet.hasChild("x", "http://jabber.org/protocol/muc")) {
504            this.parseConferencePresence(packet);
505        } else if ("error".equals(packet.getAttribute("type"))
506                && mXmppConnectionService.isMuc(getAccount(), packet.getFrom())) {
507            this.parseConferencePresence(packet);
508        } else {
509            this.parseContactPresence(packet);
510        }
511    }
512}