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