MessageGenerator.java

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