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