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