MessageParser.java

  1package eu.siacs.conversations.parser;
  2
  3import android.util.Log;
  4import android.util.Pair;
  5
  6import net.java.otr4j.session.Session;
  7import net.java.otr4j.session.SessionStatus;
  8
  9import java.util.List;
 10
 11import eu.siacs.conversations.Config;
 12import eu.siacs.conversations.crypto.axolotl.AxolotlService;
 13import eu.siacs.conversations.crypto.axolotl.XmppAxolotlMessage;
 14import eu.siacs.conversations.entities.Account;
 15import eu.siacs.conversations.entities.Contact;
 16import eu.siacs.conversations.entities.Conversation;
 17import eu.siacs.conversations.entities.Message;
 18import eu.siacs.conversations.entities.MucOptions;
 19import eu.siacs.conversations.http.HttpConnectionManager;
 20import eu.siacs.conversations.services.MessageArchiveService;
 21import eu.siacs.conversations.services.XmppConnectionService;
 22import eu.siacs.conversations.utils.CryptoHelper;
 23import eu.siacs.conversations.xml.Element;
 24import eu.siacs.conversations.xmpp.OnMessagePacketReceived;
 25import eu.siacs.conversations.xmpp.chatstate.ChatState;
 26import eu.siacs.conversations.xmpp.jid.Jid;
 27import eu.siacs.conversations.xmpp.pep.Avatar;
 28import eu.siacs.conversations.xmpp.stanzas.MessagePacket;
 29
 30public class MessageParser extends AbstractParser implements
 31		OnMessagePacketReceived {
 32	public MessageParser(XmppConnectionService service) {
 33		super(service);
 34	}
 35
 36	private boolean extractChatState(Conversation conversation, final MessagePacket packet) {
 37		ChatState state = ChatState.parse(packet);
 38		if (state != null && conversation != null) {
 39			final Account account = conversation.getAccount();
 40			Jid from = packet.getFrom();
 41			if (from.toBareJid().equals(account.getJid().toBareJid())) {
 42				conversation.setOutgoingChatState(state);
 43				return false;
 44			} else {
 45				return conversation.setIncomingChatState(state);
 46			}
 47		}
 48		return false;
 49	}
 50
 51	private Message parseOtrChat(String body, Jid from, String id, Conversation conversation) {
 52		String presence;
 53		if (from.isBareJid()) {
 54			presence = "";
 55		} else {
 56			presence = from.getResourcepart();
 57		}
 58		if (body.matches("^\\?OTRv\\d{1,2}\\?.*")) {
 59			conversation.endOtrIfNeeded();
 60		}
 61		if (!conversation.hasValidOtrSession()) {
 62			conversation.startOtrSession(presence,false);
 63		} else {
 64			String foreignPresence = conversation.getOtrSession().getSessionID().getUserID();
 65			if (!foreignPresence.equals(presence)) {
 66				conversation.endOtrIfNeeded();
 67				conversation.startOtrSession(presence, false);
 68			}
 69		}
 70		try {
 71			conversation.setLastReceivedOtrMessageId(id);
 72			Session otrSession = conversation.getOtrSession();
 73			SessionStatus before = otrSession.getSessionStatus();
 74			body = otrSession.transformReceiving(body);
 75			SessionStatus after = otrSession.getSessionStatus();
 76			if ((before != after) && (after == SessionStatus.ENCRYPTED)) {
 77				conversation.setNextEncryption(Message.ENCRYPTION_OTR);
 78				mXmppConnectionService.onOtrSessionEstablished(conversation);
 79			} else if ((before != after) && (after == SessionStatus.FINISHED)) {
 80				conversation.setNextEncryption(Message.ENCRYPTION_NONE);
 81				conversation.resetOtrSession();
 82				mXmppConnectionService.updateConversationUi();
 83			}
 84			if ((body == null) || (body.isEmpty())) {
 85				return null;
 86			}
 87			if (body.startsWith(CryptoHelper.FILETRANSFER)) {
 88				String key = body.substring(CryptoHelper.FILETRANSFER.length());
 89				conversation.setSymmetricKey(CryptoHelper.hexToBytes(key));
 90				return null;
 91			}
 92			Message finishedMessage = new Message(conversation, body, Message.ENCRYPTION_OTR, Message.STATUS_RECEIVED);
 93			conversation.setLastReceivedOtrMessageId(null);
 94			return finishedMessage;
 95		} catch (Exception e) {
 96			conversation.resetOtrSession();
 97			return null;
 98		}
 99	}
100
101    private Message parseAxolotlChat(Element axolotlMessage, Jid from, String id, Conversation conversation) {
102        Message finishedMessage = null;
103        AxolotlService service = conversation.getAccount().getAxolotlService();
104        XmppAxolotlMessage xmppAxolotlMessage = new XmppAxolotlMessage(conversation.getContact(), axolotlMessage);
105        XmppAxolotlMessage.XmppAxolotlPlaintextMessage plaintextMessage = service.processReceiving(xmppAxolotlMessage);
106        if(plaintextMessage != null) {
107            finishedMessage = new Message(conversation, plaintextMessage.getPlaintext(), Message.ENCRYPTION_AXOLOTL, Message.STATUS_RECEIVED);
108        }
109
110        return finishedMessage;
111    }
112
113	private class Invite {
114		Jid jid;
115		String password;
116		Invite(Jid jid, String password) {
117			this.jid = jid;
118			this.password = password;
119		}
120
121		public boolean execute(Account account) {
122			if (jid != null) {
123				Conversation conversation = mXmppConnectionService.findOrCreateConversation(account, jid, true);
124				if (!conversation.getMucOptions().online()) {
125					conversation.getMucOptions().setPassword(password);
126					mXmppConnectionService.databaseBackend.updateConversation(conversation);
127					mXmppConnectionService.joinMuc(conversation);
128					mXmppConnectionService.updateConversationUi();
129				}
130				return true;
131			}
132			return false;
133		}
134	}
135
136	private Invite extractInvite(Element message) {
137		Element x = message.findChild("x", "http://jabber.org/protocol/muc#user");
138		if (x != null) {
139			Element invite = x.findChild("invite");
140			if (invite != null) {
141				Element pw = x.findChild("password");
142				return new Invite(message.getAttributeAsJid("from"), pw != null ? pw.getContent(): null);
143			}
144		} else {
145			x = message.findChild("x","jabber:x:conference");
146			if (x != null) {
147				return new Invite(x.getAttributeAsJid("jid"),x.getAttribute("password"));
148			}
149		}
150		return null;
151	}
152
153	private void parseEvent(final Element event, final Jid from, final Account account) {
154		Element items = event.findChild("items");
155		String node = items == null ? null : items.getAttribute("node");
156		if ("urn:xmpp:avatar:metadata".equals(node)) {
157			Avatar avatar = Avatar.parseMetadata(items);
158			if (avatar != null) {
159				avatar.owner = from;
160				if (mXmppConnectionService.getFileBackend().isAvatarCached(avatar)) {
161					if (account.getJid().toBareJid().equals(from)) {
162						if (account.setAvatar(avatar.getFilename())) {
163							mXmppConnectionService.databaseBackend.updateAccount(account);
164						}
165						mXmppConnectionService.getAvatarService().clear(account);
166						mXmppConnectionService.updateConversationUi();
167						mXmppConnectionService.updateAccountUi();
168					} else {
169						Contact contact = account.getRoster().getContact(from);
170						contact.setAvatar(avatar);
171						mXmppConnectionService.getAvatarService().clear(contact);
172						mXmppConnectionService.updateConversationUi();
173						mXmppConnectionService.updateRosterUi();
174					}
175				} else {
176					mXmppConnectionService.fetchAvatar(account, avatar);
177				}
178			}
179		} else if ("http://jabber.org/protocol/nick".equals(node)) {
180			Element i = items.findChild("item");
181			Element nick = i == null ? null : i.findChild("nick", "http://jabber.org/protocol/nick");
182			if (nick != null) {
183				Contact contact = account.getRoster().getContact(from);
184				contact.setPresenceName(nick.getContent());
185				mXmppConnectionService.getAvatarService().clear(account);
186				mXmppConnectionService.updateConversationUi();
187				mXmppConnectionService.updateAccountUi();
188			}
189		} else if (AxolotlService.PEP_DEVICE_LIST.equals(node)) {
190            Log.d(Config.LOGTAG, "Received PEP device list update from "+ from + ", processing...");
191            Element item = items.findChild("item");
192			List<Integer> deviceIds = mXmppConnectionService.getIqParser().deviceIds(item);
193            AxolotlService axolotlService = account.getAxolotlService();
194            if(account.getJid().toBareJid().equals(from)) {
195            } else {
196                Contact contact = account.getRoster().getContact(from);
197                for (Integer deviceId : deviceIds) {
198                    axolotlService.fetchBundleIfNeeded(contact, deviceId);
199                }
200            }
201		}
202	}
203
204	private boolean handleErrorMessage(Account account, MessagePacket packet) {
205		if (packet.getType() == MessagePacket.TYPE_ERROR) {
206			Jid from = packet.getFrom();
207			if (from != null) {
208				mXmppConnectionService.markMessage(account, from.toBareJid(), packet.getId(), Message.STATUS_SEND_FAILED);
209			}
210			return true;
211		}
212		return false;
213	}
214
215	@Override
216	public void onMessagePacketReceived(Account account, MessagePacket original) {
217		if (handleErrorMessage(account, original)) {
218			return;
219		}
220		final MessagePacket packet;
221		Long timestamp = null;
222		final boolean isForwarded;
223		String serverMsgId = null;
224		final Element fin = original.findChild("fin", "urn:xmpp:mam:0");
225		if (fin != null) {
226			mXmppConnectionService.getMessageArchiveService().processFin(fin,original.getFrom());
227			return;
228		}
229		final Element result = original.findChild("result","urn:xmpp:mam:0");
230		final MessageArchiveService.Query query = result == null ? null : mXmppConnectionService.getMessageArchiveService().findQuery(result.getAttribute("queryid"));
231		if (query != null && query.validFrom(original.getFrom())) {
232			Pair<MessagePacket, Long> f = original.getForwardedMessagePacket("result", "urn:xmpp:mam:0");
233			if (f == null) {
234				return;
235			}
236			timestamp = f.second;
237			packet = f.first;
238			isForwarded = true;
239			serverMsgId = result.getAttribute("id");
240			query.incrementTotalCount();
241		} else if (query != null) {
242			Log.d(Config.LOGTAG,account.getJid().toBareJid()+": received mam result from invalid sender");
243			return;
244		} else if (original.fromServer(account)) {
245			Pair<MessagePacket, Long> f;
246			f = original.getForwardedMessagePacket("received", "urn:xmpp:carbons:2");
247			f = f == null ? original.getForwardedMessagePacket("sent", "urn:xmpp:carbons:2") : f;
248			packet = f != null ? f.first : original;
249			if (handleErrorMessage(account, packet)) {
250				return;
251			}
252			timestamp = f != null ? f.second : null;
253			isForwarded = f != null;
254		} else {
255			packet = original;
256			isForwarded = false;
257		}
258
259		if (timestamp == null) {
260			timestamp = AbstractParser.getTimestamp(packet, System.currentTimeMillis());
261		}
262		final String body = packet.getBody();
263		final Element mucUserElement = packet.findChild("x","http://jabber.org/protocol/muc#user");
264		final String pgpEncrypted = packet.findChildContent("x", "jabber:x:encrypted");
265        final Element axolotlEncrypted = packet.findChild("axolotl_message", AxolotlService.PEP_PREFIX);
266		int status;
267		final Jid counterpart;
268		final Jid to = packet.getTo();
269		final Jid from = packet.getFrom();
270		final String remoteMsgId = packet.getId();
271
272		if (from == null || to == null) {
273			Log.d(Config.LOGTAG,"no to or from in: "+packet.toString());
274			return;
275		}
276		
277		boolean isTypeGroupChat = packet.getType() == MessagePacket.TYPE_GROUPCHAT;
278		boolean isProperlyAddressed = !to.isBareJid() || account.countPresences() == 1;
279		boolean isMucStatusMessage = from.isBareJid() && mucUserElement != null && mucUserElement.hasChild("status");
280		if (packet.fromAccount(account)) {
281			status = Message.STATUS_SEND;
282			counterpart = to;
283		} else {
284			status = Message.STATUS_RECEIVED;
285			counterpart = from;
286		}
287
288		Invite invite = extractInvite(packet);
289		if (invite != null && invite.execute(account)) {
290			return;
291		}
292
293		if (extractChatState(mXmppConnectionService.find(account, from), packet)) {
294			mXmppConnectionService.updateConversationUi();
295		}
296
297		if ((body != null || pgpEncrypted != null || axolotlEncrypted != null) && !isMucStatusMessage) {
298			Conversation conversation = mXmppConnectionService.findOrCreateConversation(account, counterpart.toBareJid(), isTypeGroupChat);
299			if (isTypeGroupChat) {
300				if (counterpart.getResourcepart().equals(conversation.getMucOptions().getActualNick())) {
301					status = Message.STATUS_SEND_RECEIVED;
302					if (mXmppConnectionService.markMessage(conversation, remoteMsgId, status)) {
303						return;
304					} else {
305						Message message = conversation.findSentMessageWithBody(body);
306						if (message != null) {
307							message.setRemoteMsgId(remoteMsgId);
308							mXmppConnectionService.markMessage(message, status);
309							return;
310						}
311					}
312				} else {
313					status = Message.STATUS_RECEIVED;
314				}
315			}
316			Message message;
317			if (body != null && body.startsWith("?OTR")) {
318				if (!isForwarded && !isTypeGroupChat && isProperlyAddressed) {
319					message = parseOtrChat(body, from, remoteMsgId, conversation);
320					if (message == null) {
321						return;
322					}
323				} else {
324					message = new Message(conversation, body, Message.ENCRYPTION_NONE, status);
325				}
326			} else if (pgpEncrypted != null) {
327                message = new Message(conversation, pgpEncrypted, Message.ENCRYPTION_PGP, status);
328            } else if (axolotlEncrypted != null) {
329                message = parseAxolotlChat(axolotlEncrypted, from, remoteMsgId, conversation);
330                if (message == null) {
331                    return;
332                }
333            } else {
334				message = new Message(conversation, body, Message.ENCRYPTION_NONE, status);
335			}
336			message.setCounterpart(counterpart);
337			message.setRemoteMsgId(remoteMsgId);
338			message.setServerMsgId(serverMsgId);
339			message.setTime(timestamp);
340			message.markable = packet.hasChild("markable", "urn:xmpp:chat-markers:0");
341			if (conversation.getMode() == Conversation.MODE_MULTI) {
342				message.setTrueCounterpart(conversation.getMucOptions().getTrueCounterpart(counterpart.getResourcepart()));
343				if (!isTypeGroupChat) {
344					message.setType(Message.TYPE_PRIVATE);
345				}
346			}
347			updateLastseen(packet,account,true);
348			boolean checkForDuplicates = serverMsgId != null
349					|| (isTypeGroupChat && packet.hasChild("delay","urn:xmpp:delay"))
350					|| message.getType() == Message.TYPE_PRIVATE;
351			if (checkForDuplicates && conversation.hasDuplicateMessage(message)) {
352				Log.d(Config.LOGTAG,"skipping duplicate message from "+message.getCounterpart().toString()+" "+message.getBody());
353				return;
354			}
355			if (query != null) {
356				query.incrementMessageCount();
357			}
358			conversation.add(message);
359			if (serverMsgId == null) {
360				if (status == Message.STATUS_SEND || status == Message.STATUS_SEND_RECEIVED) {
361					mXmppConnectionService.markRead(conversation);
362					account.activateGracePeriod();
363				} else {
364					message.markUnread();
365				}
366				mXmppConnectionService.updateConversationUi();
367			}
368
369			if (mXmppConnectionService.confirmMessages() && remoteMsgId != null && !isForwarded) {
370				if (packet.hasChild("markable", "urn:xmpp:chat-markers:0")) {
371					MessagePacket receipt = mXmppConnectionService
372							.getMessageGenerator().received(account, packet, "urn:xmpp:chat-markers:0");
373					mXmppConnectionService.sendMessagePacket(account, receipt);
374				}
375				if (packet.hasChild("request", "urn:xmpp:receipts")) {
376					MessagePacket receipt = mXmppConnectionService
377							.getMessageGenerator().received(account, packet, "urn:xmpp:receipts");
378					mXmppConnectionService.sendMessagePacket(account, receipt);
379				}
380			}
381			if (account.getXmppConnection() != null && account.getXmppConnection().getFeatures().advancedStreamFeaturesLoaded()) {
382				if (conversation.setLastMessageTransmitted(System.currentTimeMillis())) {
383					mXmppConnectionService.updateConversation(conversation);
384				}
385			}
386
387			if (message.getStatus() == Message.STATUS_RECEIVED
388					&& conversation.getOtrSession() != null
389					&& !conversation.getOtrSession().getSessionID().getUserID()
390					.equals(message.getCounterpart().getResourcepart())) {
391				conversation.endOtrIfNeeded();
392			}
393
394			if (message.getEncryption() == Message.ENCRYPTION_NONE || mXmppConnectionService.saveEncryptedMessages()) {
395				mXmppConnectionService.databaseBackend.createMessage(message);
396			}
397			final HttpConnectionManager manager = this.mXmppConnectionService.getHttpConnectionManager();
398			if (message.trusted() && message.treatAsDownloadable() != Message.Decision.NEVER && manager.getAutoAcceptFileSize() > 0) {
399				manager.createNewDownloadConnection(message);
400			} else if (!message.isRead()) {
401				mXmppConnectionService.getNotificationService().push(message);
402			}
403		} else { //no body
404			if (isTypeGroupChat) {
405				Conversation conversation = mXmppConnectionService.find(account, from.toBareJid());
406				if (packet.hasChild("subject")) {
407					if (conversation != null && conversation.getMode() == Conversation.MODE_MULTI) {
408						conversation.setHasMessagesLeftOnServer(conversation.countMessages() > 0);
409						conversation.getMucOptions().setSubject(packet.findChildContent("subject"));
410						mXmppConnectionService.updateConversationUi();
411						return;
412					}
413				}
414
415				if (conversation != null && isMucStatusMessage) {
416					for (Element child : mucUserElement.getChildren()) {
417						if (child.getName().equals("status")
418								&& MucOptions.STATUS_CODE_ROOM_CONFIG_CHANGED.equals(child.getAttribute("code"))) {
419							mXmppConnectionService.fetchConferenceConfiguration(conversation);
420						}
421					}
422				}
423			}
424		}
425
426		Element received = packet.findChild("received", "urn:xmpp:chat-markers:0");
427		if (received == null) {
428			received = packet.findChild("received", "urn:xmpp:receipts");
429		}
430		if (received != null && !packet.fromAccount(account)) {
431			mXmppConnectionService.markMessage(account, from.toBareJid(), received.getAttribute("id"), Message.STATUS_SEND_RECEIVED);
432		}
433		Element displayed = packet.findChild("displayed", "urn:xmpp:chat-markers:0");
434		if (displayed != null) {
435			if (packet.fromAccount(account)) {
436				Conversation conversation = mXmppConnectionService.find(account,counterpart.toBareJid());
437				if (conversation != null) {
438					mXmppConnectionService.markRead(conversation);
439				}
440			} else {
441				updateLastseen(packet, account, true);
442				final Message displayedMessage = mXmppConnectionService.markMessage(account, from.toBareJid(), displayed.getAttribute("id"), Message.STATUS_SEND_DISPLAYED);
443				Message message = displayedMessage == null ? null : displayedMessage.prev();
444				while (message != null
445						&& message.getStatus() == Message.STATUS_SEND_RECEIVED
446						&& message.getTimeSent() < displayedMessage.getTimeSent()) {
447					mXmppConnectionService.markMessage(message, Message.STATUS_SEND_DISPLAYED);
448					message = message.prev();
449				}
450			}
451		}
452
453		Element event = packet.findChild("event", "http://jabber.org/protocol/pubsub#event");
454		if (event != null) {
455			parseEvent(event, from, account);
456		}
457
458		String nick = packet.findChildContent("nick", "http://jabber.org/protocol/nick");
459		if (nick != null) {
460			Contact contact = account.getRoster().getContact(from);
461			contact.setPresenceName(nick);
462		}
463	}
464}