MessageGenerator.java

  1package eu.siacs.conversations.generator;
  2
  3import java.text.SimpleDateFormat;
  4import java.util.ArrayList;
  5import java.util.Date;
  6import java.util.Locale;
  7import java.util.TimeZone;
  8
  9import eu.siacs.conversations.Config;
 10import eu.siacs.conversations.crypto.axolotl.AxolotlService;
 11import eu.siacs.conversations.crypto.axolotl.XmppAxolotlMessage;
 12import eu.siacs.conversations.entities.Account;
 13import eu.siacs.conversations.entities.Conversation;
 14import eu.siacs.conversations.entities.Conversational;
 15import eu.siacs.conversations.entities.Message;
 16import eu.siacs.conversations.services.XmppConnectionService;
 17import eu.siacs.conversations.xml.Element;
 18import eu.siacs.conversations.xml.Namespace;
 19import eu.siacs.conversations.xmpp.Jid;
 20import eu.siacs.conversations.xmpp.chatstate.ChatState;
 21import eu.siacs.conversations.xmpp.forms.Data;
 22import eu.siacs.conversations.xmpp.jingle.JingleConnectionManager;
 23import eu.siacs.conversations.xmpp.jingle.JingleRtpConnection;
 24import eu.siacs.conversations.xmpp.jingle.Media;
 25import eu.siacs.conversations.xmpp.jingle.stanzas.Reason;
 26
 27public class MessageGenerator extends AbstractGenerator {
 28    private static final String OMEMO_FALLBACK_MESSAGE = "I sent you an OMEMO encrypted message but your client doesn’t seem to support that. Find more information on https://conversations.im/omemo";
 29    private static final String PGP_FALLBACK_MESSAGE = "I sent you a PGP encrypted message but your client doesn’t seem to support that.";
 30
 31    public MessageGenerator(XmppConnectionService service) {
 32        super(service);
 33    }
 34
 35    private im.conversations.android.xmpp.model.stanza.Message preparePacket(Message message, boolean legacyEncryption) {
 36        Conversation conversation = (Conversation) message.getConversation();
 37        Account account = conversation.getAccount();
 38        im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
 39        final boolean isWithSelf = conversation.getContact().isSelf();
 40        if (conversation.getMode() == Conversation.MODE_SINGLE) {
 41            packet.setTo(message.getCounterpart());
 42            packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT);
 43            if (!isWithSelf) {
 44                packet.addChild("request", "urn:xmpp:receipts");
 45            }
 46        } else if (message.isPrivateMessage()) {
 47            packet.setTo(message.getCounterpart());
 48            packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT);
 49            packet.addChild("x", "http://jabber.org/protocol/muc#user");
 50            packet.addChild("request", "urn:xmpp:receipts");
 51        } else {
 52            packet.setTo(message.getCounterpart().asBareJid());
 53            packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.GROUPCHAT);
 54        }
 55        if (conversation.isSingleOrPrivateAndNonAnonymous() && !message.isPrivateMessage()) {
 56            packet.addChild("markable", "urn:xmpp:chat-markers:0");
 57        }
 58        packet.setFrom(account.getJid());
 59        packet.setId(message.getUuid());
 60        if (conversation.getMode() == Conversational.MODE_SINGLE || message.isPrivateMessage() || !conversation.getMucOptions().stableId()) {
 61            packet.addChild("origin-id", Namespace.STANZA_IDS).setAttribute("id", message.getUuid());
 62        }
 63        if (message.edited()) {
 64            packet.addChild("replace", "urn:xmpp:message-correct:0").setAttribute("id", message.getEditedIdWireFormat());
 65        }
 66        if (!legacyEncryption) {
 67            if (message.getSubject() != null && message.getSubject().length() > 0) packet.addChild("subject").setContent(message.getSubject());
 68            // Legacy encryption can't handle advanced payloads
 69            for (Element el : message.getPayloads()) {
 70                packet.addChild(el);
 71            }
 72        } else {
 73            for (Element el : message.getPayloads()) {
 74                if ("thread".equals(el.getName())) packet.addChild(el);
 75            }
 76        }
 77        return packet;
 78    }
 79
 80    public void addDelay(im.conversations.android.xmpp.model.stanza.Message packet, long timestamp) {
 81        final SimpleDateFormat mDateFormat = new SimpleDateFormat(
 82                "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.US);
 83        mDateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
 84        Element delay = packet.addChild("delay", "urn:xmpp:delay");
 85        Date date = new Date(timestamp);
 86        delay.setAttribute("stamp", mDateFormat.format(date));
 87    }
 88
 89    public im.conversations.android.xmpp.model.stanza.Message generateAxolotlChat(Message message, XmppAxolotlMessage axolotlMessage) {
 90        im.conversations.android.xmpp.model.stanza.Message packet = preparePacket(message, true);
 91        if (axolotlMessage == null) {
 92            return null;
 93        }
 94        packet.setAxolotlMessage(axolotlMessage.toElement());
 95        packet.setBody(OMEMO_FALLBACK_MESSAGE);
 96        packet.addChild("store", "urn:xmpp:hints");
 97        packet.addChild("encryption", "urn:xmpp:eme:0")
 98                .setAttribute("name", "OMEMO")
 99                .setAttribute("namespace", AxolotlService.PEP_PREFIX);
100        return packet;
101    }
102
103    public im.conversations.android.xmpp.model.stanza.Message generateKeyTransportMessage(Jid to, XmppAxolotlMessage axolotlMessage) {
104        im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
105        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT);
106        packet.setTo(to);
107        packet.setAxolotlMessage(axolotlMessage.toElement());
108        packet.addChild("store", "urn:xmpp:hints");
109        return packet;
110    }
111
112    public im.conversations.android.xmpp.model.stanza.Message generateChat(Message message) {
113        im.conversations.android.xmpp.model.stanza.Message packet = preparePacket(message, false);
114        String content;
115        if (message.hasFileOnRemoteHost()) {
116            final Message.FileParams fileParams = message.getFileParams();
117
118            if (message.getFallbacks(Namespace.OOB).isEmpty()) {
119                if (message.getBody().equals("")) {
120                    message.setBody(fileParams.url);
121                    final var fallback = new Element("fallback", "urn:xmpp:fallback:0").setAttribute("for", Namespace.OOB);
122                    fallback.addChild("body", "urn:xmpp:fallback:0");
123                    message.addPayload(fallback);
124                } else {
125                    long start = message.getRawBody().codePointCount(0, message.getRawBody().length());
126                    message.appendBody(fileParams.url);
127                    final var fallback = new Element("fallback", "urn:xmpp:fallback:0").setAttribute("for", Namespace.OOB);
128                    fallback.addChild("body", "urn:xmpp:fallback:0")
129                        .setAttribute("start", String.valueOf(start))
130                        .setAttribute("end", String.valueOf(start + fileParams.url.length()));
131                    message.addPayload(fallback);
132                }
133            }
134
135            packet = preparePacket(message, false);
136            packet.addChild("x", Namespace.OOB).addChild("url").setContent(fileParams.url);
137        }
138        if (message.getRawBody() != null) packet.setBody(message.getRawBody());
139        return packet;
140    }
141
142    public im.conversations.android.xmpp.model.stanza.Message generatePgpChat(Message message) {
143        final im.conversations.android.xmpp.model.stanza.Message packet = preparePacket(message, true);
144        if (message.hasFileOnRemoteHost()) {
145            Message.FileParams fileParams = message.getFileParams();
146            final String url = fileParams.url;
147            packet.setBody(url);
148            packet.addChild("x", Namespace.OOB).addChild("url").setContent(url);
149            packet.addChild("fallback", "urn:xmpp:fallback:0").setAttribute("for", Namespace.OOB)
150                  .addChild("body", "urn:xmpp:fallback:0");
151        } else {
152            if (Config.supportUnencrypted()) {
153                packet.setBody(PGP_FALLBACK_MESSAGE);
154            }
155            if (message.getEncryption() == Message.ENCRYPTION_DECRYPTED) {
156                packet.addChild("x", "jabber:x:encrypted").setContent(message.getEncryptedBody());
157            } else if (message.getEncryption() == Message.ENCRYPTION_PGP) {
158                packet.addChild("x", "jabber:x:encrypted").setContent(message.getBody());
159            }
160            packet.addChild("encryption", "urn:xmpp:eme:0")
161                    .setAttribute("namespace", "jabber:x:encrypted");
162        }
163        return packet;
164    }
165
166    public im.conversations.android.xmpp.model.stanza.Message generateChatState(Conversation conversation) {
167        final Account account = conversation.getAccount();
168        final im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
169        packet.setType(conversation.getMode() == Conversation.MODE_MULTI ? im.conversations.android.xmpp.model.stanza.Message.Type.GROUPCHAT : im.conversations.android.xmpp.model.stanza.Message.Type.CHAT);
170        packet.setTo(conversation.getJid().asBareJid());
171        packet.setFrom(account.getJid());
172        packet.addChild(ChatState.toElement(conversation.getOutgoingChatState()));
173        packet.addChild("no-store", "urn:xmpp:hints");
174        packet.addChild("no-storage", "urn:xmpp:hints"); //wrong! don't copy this. Its *store*
175        return packet;
176    }
177
178    public im.conversations.android.xmpp.model.stanza.Message confirm(final Message message) {
179        final boolean groupChat = message.getConversation().getMode() == Conversational.MODE_MULTI;
180        final Jid to = message.getCounterpart();
181        final im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
182        packet.setType(groupChat ? im.conversations.android.xmpp.model.stanza.Message.Type.GROUPCHAT : im.conversations.android.xmpp.model.stanza.Message.Type.CHAT);
183        packet.setTo(groupChat ? to.asBareJid() : to);
184        final Element displayed = packet.addChild("displayed", "urn:xmpp:chat-markers:0");
185        if (groupChat) {
186            final String stanzaId = message.getServerMsgId();
187            if (stanzaId != null) {
188                displayed.setAttribute("id", stanzaId);
189            } else {
190                displayed.setAttribute("sender", to.toString());
191                displayed.setAttribute("id", message.getRemoteMsgId());
192            }
193        } else {
194            displayed.setAttribute("id", message.getRemoteMsgId());
195        }
196        packet.addChild("store", "urn:xmpp:hints");
197        return packet;
198    }
199
200    public im.conversations.android.xmpp.model.stanza.Message conferenceSubject(Conversation conversation, String subject) {
201        im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
202        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.GROUPCHAT);
203        packet.setTo(conversation.getJid().asBareJid());
204        packet.addChild("subject").setContent(subject);
205        packet.setFrom(conversation.getAccount().getJid().asBareJid());
206        return packet;
207    }
208
209    public im.conversations.android.xmpp.model.stanza.Message requestVoice(Jid jid) {
210        final var packet = new im.conversations.android.xmpp.model.stanza.Message();
211        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.NORMAL);
212        packet.setTo(jid.asBareJid());
213        final var form = new Data();
214        form.setFormType("http://jabber.org/protocol/muc#request");
215        form.put("muc#role", "participant");
216        form.submit();
217        packet.addChild(form);
218        return packet;
219    }
220
221    public im.conversations.android.xmpp.model.stanza.Message directInvite(final Conversation conversation, final Jid contact) {
222        im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
223        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.NORMAL);
224        packet.setTo(contact);
225        packet.setFrom(conversation.getAccount().getJid());
226        Element x = packet.addChild("x", "jabber:x:conference");
227        x.setAttribute("jid", conversation.getJid().asBareJid());
228        String password = conversation.getMucOptions().getPassword();
229        if (password != null) {
230            x.setAttribute("password", password);
231        }
232        if (contact.isFullJid()) {
233            packet.addChild("no-store", "urn:xmpp:hints");
234            packet.addChild("no-copy", "urn:xmpp:hints");
235        }
236        return packet;
237    }
238
239    public im.conversations.android.xmpp.model.stanza.Message invite(final Conversation conversation, final Jid contact) {
240        final var packet = new im.conversations.android.xmpp.model.stanza.Message();
241        packet.setTo(conversation.getJid().asBareJid());
242        packet.setFrom(conversation.getAccount().getJid());
243        Element x = new Element("x");
244        x.setAttribute("xmlns", "http://jabber.org/protocol/muc#user");
245        Element invite = new Element("invite");
246        invite.setAttribute("to", contact.asBareJid());
247        x.addChild(invite);
248        packet.addChild(x);
249        return packet;
250    }
251
252    public im.conversations.android.xmpp.model.stanza.Message received(Account account, final Jid from, final String id, ArrayList<String> namespaces, im.conversations.android.xmpp.model.stanza.Message.Type type) {
253        final var receivedPacket =
254                new im.conversations.android.xmpp.model.stanza.Message();
255        receivedPacket.setType(type);
256        receivedPacket.setTo(from);
257        receivedPacket.setFrom(account.getJid());
258        for (final String namespace : namespaces) {
259            receivedPacket.addChild("received", namespace).setAttribute("id", id);
260        }
261        receivedPacket.addChild("store", "urn:xmpp:hints");
262        return receivedPacket;
263    }
264
265    public im.conversations.android.xmpp.model.stanza.Message received(Account account, Jid to, String id) {
266        im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
267        packet.setFrom(account.getJid());
268        packet.setTo(to);
269        packet.addChild("received", "urn:xmpp:receipts").setAttribute("id", id);
270        packet.addChild("store", "urn:xmpp:hints");
271        return packet;
272    }
273
274    public im.conversations.android.xmpp.model.stanza.Message sessionFinish(
275            final Jid with, final String sessionId, final Reason reason) {
276        final im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
277        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT);
278        packet.setTo(with);
279        final Element finish = packet.addChild("finish", Namespace.JINGLE_MESSAGE);
280        finish.setAttribute("id", sessionId);
281        final Element reasonElement = finish.addChild("reason", Namespace.JINGLE);
282        reasonElement.addChild(reason.toString());
283        packet.addChild("store", "urn:xmpp:hints");
284        return packet;
285    }
286
287    public im.conversations.android.xmpp.model.stanza.Message sessionProposal(final JingleConnectionManager.RtpSessionProposal proposal) {
288        final im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
289        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT); //we want to carbon copy those
290        packet.setTo(proposal.with);
291        packet.setId(JingleRtpConnection.JINGLE_MESSAGE_PROPOSE_ID_PREFIX + proposal.sessionId);
292        final Element propose = packet.addChild("propose", Namespace.JINGLE_MESSAGE);
293        propose.setAttribute("id", proposal.sessionId);
294        for (final Media media : proposal.media) {
295            propose.addChild("description", Namespace.JINGLE_APPS_RTP).setAttribute("media", media.toString());
296        }
297        packet.addChild("request", "urn:xmpp:receipts");
298        packet.addChild("store", "urn:xmpp:hints");
299        return packet;
300    }
301
302    public im.conversations.android.xmpp.model.stanza.Message sessionRetract(final JingleConnectionManager.RtpSessionProposal proposal) {
303        final im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
304        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT); //we want to carbon copy those
305        packet.setTo(proposal.with);
306        final Element propose = packet.addChild("retract", Namespace.JINGLE_MESSAGE);
307        propose.setAttribute("id", proposal.sessionId);
308        propose.addChild("description", Namespace.JINGLE_APPS_RTP);
309        packet.addChild("store", "urn:xmpp:hints");
310        return packet;
311    }
312
313    public im.conversations.android.xmpp.model.stanza.Message sessionReject(final Jid with, final String sessionId) {
314        final im.conversations.android.xmpp.model.stanza.Message packet = new im.conversations.android.xmpp.model.stanza.Message();
315        packet.setType(im.conversations.android.xmpp.model.stanza.Message.Type.CHAT); //we want to carbon copy those
316        packet.setTo(with);
317        final Element propose = packet.addChild("reject", Namespace.JINGLE_MESSAGE);
318        propose.setAttribute("id", sessionId);
319        propose.addChild("description", Namespace.JINGLE_APPS_RTP);
320        packet.addChild("store", "urn:xmpp:hints");
321        return packet;
322    }
323}