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