MessageGenerator.java

  1package eu.siacs.conversations.generator;
  2
  3import java.net.URL;
  4import java.text.SimpleDateFormat;
  5import java.util.ArrayList;
  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.Message;
 16import eu.siacs.conversations.http.P1S3UrlStreamHandler;
 17import eu.siacs.conversations.services.XmppConnectionService;
 18import eu.siacs.conversations.xml.Element;
 19import eu.siacs.conversations.xml.Namespace;
 20import eu.siacs.conversations.xmpp.chatstate.ChatState;
 21import eu.siacs.conversations.xmpp.jingle.JingleConnectionManager;
 22import eu.siacs.conversations.xmpp.jingle.JingleRtpConnection;
 23import eu.siacs.conversations.xmpp.jingle.Media;
 24import eu.siacs.conversations.xmpp.stanzas.MessagePacket;
 25import rocks.xmpp.addr.Jid;
 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 MessagePacket preparePacket(Message message) {
 36        Conversation conversation = (Conversation) message.getConversation();
 37        Account account = conversation.getAccount();
 38        MessagePacket packet = new MessagePacket();
 39        final boolean isWithSelf = conversation.getContact().isSelf();
 40        if (conversation.getMode() == Conversation.MODE_SINGLE) {
 41            packet.setTo(message.getCounterpart());
 42            packet.setType(MessagePacket.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(MessagePacket.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(MessagePacket.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        packet.addChild("origin-id", Namespace.STANZA_IDS).setAttribute("id", message.getUuid());
 61        if (message.edited()) {
 62            packet.addChild("replace", "urn:xmpp:message-correct:0").setAttribute("id", message.getEditedIdWireFormat());
 63        }
 64        return packet;
 65    }
 66
 67    public void addDelay(MessagePacket packet, long timestamp) {
 68        final SimpleDateFormat mDateFormat = new SimpleDateFormat(
 69                "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.US);
 70        mDateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
 71        Element delay = packet.addChild("delay", "urn:xmpp:delay");
 72        Date date = new Date(timestamp);
 73        delay.setAttribute("stamp", mDateFormat.format(date));
 74    }
 75
 76    public MessagePacket generateAxolotlChat(Message message, XmppAxolotlMessage axolotlMessage) {
 77        MessagePacket packet = preparePacket(message);
 78        if (axolotlMessage == null) {
 79            return null;
 80        }
 81        packet.setAxolotlMessage(axolotlMessage.toElement());
 82        packet.setBody(OMEMO_FALLBACK_MESSAGE);
 83        packet.addChild("store", "urn:xmpp:hints");
 84        packet.addChild("encryption", "urn:xmpp:eme:0")
 85                .setAttribute("name", "OMEMO")
 86                .setAttribute("namespace", AxolotlService.PEP_PREFIX);
 87        return packet;
 88    }
 89
 90    public MessagePacket generateKeyTransportMessage(Jid to, XmppAxolotlMessage axolotlMessage) {
 91        MessagePacket packet = new MessagePacket();
 92        packet.setType(MessagePacket.TYPE_CHAT);
 93        packet.setTo(to);
 94        packet.setAxolotlMessage(axolotlMessage.toElement());
 95        packet.addChild("store", "urn:xmpp:hints");
 96        return packet;
 97    }
 98
 99    public MessagePacket generateChat(Message message) {
100        MessagePacket packet = preparePacket(message);
101        String content;
102        if (message.hasFileOnRemoteHost()) {
103            Message.FileParams fileParams = message.getFileParams();
104            final URL url = fileParams.url;
105            if (P1S3UrlStreamHandler.PROTOCOL_NAME.equals(url.getProtocol())) {
106                Element x = packet.addChild("x", Namespace.P1_S3_FILE_TRANSFER);
107                final String file = url.getFile();
108                x.setAttribute("name", file.charAt(0) == '/' ? file.substring(1) : file);
109                x.setAttribute("fileid", url.getHost());
110                return packet;
111            } else {
112                content = url.toString();
113                packet.addChild("x", Namespace.OOB).addChild("url").setContent(content);
114            }
115        } else {
116            content = message.getBody();
117        }
118        packet.setBody(content);
119        return packet;
120    }
121
122    public MessagePacket generatePgpChat(Message message) {
123        MessagePacket packet = preparePacket(message);
124        if (message.hasFileOnRemoteHost()) {
125            Message.FileParams fileParams = message.getFileParams();
126            final URL url = fileParams.url;
127            if (P1S3UrlStreamHandler.PROTOCOL_NAME.equals(url.getProtocol())) {
128                Element x = packet.addChild("x", Namespace.P1_S3_FILE_TRANSFER);
129                final String file = url.getFile();
130                x.setAttribute("name", file.charAt(0) == '/' ? file.substring(1) : file);
131                x.setAttribute("fileid", url.getHost());
132            } else {
133                packet.setBody(url.toString());
134                packet.addChild("x", Namespace.OOB).addChild("url").setContent(url.toString());
135            }
136        } else {
137            if (Config.supportUnencrypted()) {
138                packet.setBody(PGP_FALLBACK_MESSAGE);
139            }
140            if (message.getEncryption() == Message.ENCRYPTION_DECRYPTED) {
141                packet.addChild("x", "jabber:x:encrypted").setContent(message.getEncryptedBody());
142            } else if (message.getEncryption() == Message.ENCRYPTION_PGP) {
143                packet.addChild("x", "jabber:x:encrypted").setContent(message.getBody());
144            }
145            packet.addChild("encryption", "urn:xmpp:eme:0")
146                    .setAttribute("namespace", "jabber:x:encrypted");
147        }
148        return packet;
149    }
150
151    public MessagePacket generateChatState(Conversation conversation) {
152        final Account account = conversation.getAccount();
153        MessagePacket packet = new MessagePacket();
154        packet.setType(conversation.getMode() == Conversation.MODE_MULTI ? MessagePacket.TYPE_GROUPCHAT : MessagePacket.TYPE_CHAT);
155        packet.setTo(conversation.getJid().asBareJid());
156        packet.setFrom(account.getJid());
157        packet.addChild(ChatState.toElement(conversation.getOutgoingChatState()));
158        packet.addChild("no-store", "urn:xmpp:hints");
159        packet.addChild("no-storage", "urn:xmpp:hints"); //wrong! don't copy this. Its *store*
160        return packet;
161    }
162
163    public MessagePacket confirm(final Account account, final Jid to, final String id, final Jid counterpart, final boolean groupChat) {
164        MessagePacket packet = new MessagePacket();
165        packet.setType(groupChat ? MessagePacket.TYPE_GROUPCHAT : MessagePacket.TYPE_CHAT);
166        packet.setTo(groupChat ? to.asBareJid() : to);
167        packet.setFrom(account.getJid());
168        Element displayed = packet.addChild("displayed", "urn:xmpp:chat-markers:0");
169        displayed.setAttribute("id", id);
170        if (groupChat && counterpart != null) {
171            displayed.setAttribute("sender", counterpart.toString());
172        }
173        packet.addChild("store", "urn:xmpp:hints");
174        return packet;
175    }
176
177    public MessagePacket conferenceSubject(Conversation conversation, String subject) {
178        MessagePacket packet = new MessagePacket();
179        packet.setType(MessagePacket.TYPE_GROUPCHAT);
180        packet.setTo(conversation.getJid().asBareJid());
181        packet.addChild("subject").setContent(subject);
182        packet.setFrom(conversation.getAccount().getJid().asBareJid());
183        return packet;
184    }
185
186    public MessagePacket directInvite(final Conversation conversation, final Jid contact) {
187        MessagePacket packet = new MessagePacket();
188        packet.setType(MessagePacket.TYPE_NORMAL);
189        packet.setTo(contact);
190        packet.setFrom(conversation.getAccount().getJid());
191        Element x = packet.addChild("x", "jabber:x:conference");
192        x.setAttribute("jid", conversation.getJid().asBareJid().toString());
193        String password = conversation.getMucOptions().getPassword();
194        if (password != null) {
195            x.setAttribute("password", password);
196        }
197        if (contact.isFullJid()) {
198            packet.addChild("no-store", "urn:xmpp:hints");
199            packet.addChild("no-copy", "urn:xmpp:hints");
200        }
201        return packet;
202    }
203
204    public MessagePacket invite(Conversation conversation, Jid contact) {
205        MessagePacket packet = new MessagePacket();
206        packet.setTo(conversation.getJid().asBareJid());
207        packet.setFrom(conversation.getAccount().getJid());
208        Element x = new Element("x");
209        x.setAttribute("xmlns", "http://jabber.org/protocol/muc#user");
210        Element invite = new Element("invite");
211        invite.setAttribute("to", contact.asBareJid().toString());
212        x.addChild(invite);
213        packet.addChild(x);
214        return packet;
215    }
216
217    public MessagePacket received(Account account, MessagePacket originalMessage, ArrayList<String> namespaces, int type) {
218        MessagePacket receivedPacket = new MessagePacket();
219        receivedPacket.setType(type);
220        receivedPacket.setTo(originalMessage.getFrom());
221        receivedPacket.setFrom(account.getJid());
222        for (String namespace : namespaces) {
223            receivedPacket.addChild("received", namespace).setAttribute("id", originalMessage.getId());
224        }
225        receivedPacket.addChild("store", "urn:xmpp:hints");
226        return receivedPacket;
227    }
228
229    public MessagePacket received(Account account, Jid to, String id) {
230        MessagePacket packet = new MessagePacket();
231        packet.setFrom(account.getJid());
232        packet.setTo(to);
233        packet.addChild("received", "urn:xmpp:receipts").setAttribute("id", id);
234        packet.addChild("store", "urn:xmpp:hints");
235        return packet;
236    }
237
238    public MessagePacket sessionProposal(final JingleConnectionManager.RtpSessionProposal proposal) {
239        final MessagePacket packet = new MessagePacket();
240        packet.setType(MessagePacket.TYPE_CHAT); //we want to carbon copy those
241        packet.setTo(proposal.with);
242        packet.setId(JingleRtpConnection.JINGLE_MESSAGE_PROPOSE_ID_PREFIX + proposal.sessionId);
243        final Element propose = packet.addChild("propose", Namespace.JINGLE_MESSAGE);
244        propose.setAttribute("id", proposal.sessionId);
245        for (final Media media : proposal.media) {
246            propose.addChild("description", Namespace.JINGLE_APPS_RTP).setAttribute("media", media.toString());
247        }
248
249        packet.addChild("request", "urn:xmpp:receipts");
250        packet.addChild("store", "urn:xmpp:hints");
251        return packet;
252    }
253
254    public MessagePacket sessionRetract(final JingleConnectionManager.RtpSessionProposal proposal) {
255        final MessagePacket packet = new MessagePacket();
256        packet.setType(MessagePacket.TYPE_CHAT); //we want to carbon copy those
257        packet.setTo(proposal.with);
258        final Element propose = packet.addChild("retract", Namespace.JINGLE_MESSAGE);
259        propose.setAttribute("id", proposal.sessionId);
260        propose.addChild("description", Namespace.JINGLE_APPS_RTP);
261        packet.addChild("store", "urn:xmpp:hints");
262        return packet;
263    }
264
265    public MessagePacket sessionReject(final Jid with, final String sessionId) {
266        final MessagePacket packet = new MessagePacket();
267        packet.setType(MessagePacket.TYPE_CHAT); //we want to carbon copy those
268        packet.setTo(with);
269        final Element propose = packet.addChild("reject", Namespace.JINGLE_MESSAGE);
270        propose.setAttribute("id", sessionId);
271        propose.addChild("description", Namespace.JINGLE_APPS_RTP);
272        packet.addChild("store", "urn:xmpp:hints");
273        return packet;
274    }
275}