MessageParser.java

  1package eu.siacs.conversations.parser;
  2
  3import android.os.SystemClock;
  4import net.java.otr4j.session.Session;
  5import net.java.otr4j.session.SessionStatus;
  6import eu.siacs.conversations.Config;
  7import eu.siacs.conversations.entities.Account;
  8import eu.siacs.conversations.entities.Contact;
  9import eu.siacs.conversations.entities.Conversation;
 10import eu.siacs.conversations.entities.Message;
 11import eu.siacs.conversations.services.XmppConnectionService;
 12import eu.siacs.conversations.utils.CryptoHelper;
 13import eu.siacs.conversations.xml.Element;
 14import eu.siacs.conversations.xmpp.OnMessagePacketReceived;
 15import eu.siacs.conversations.xmpp.pep.Avatar;
 16import eu.siacs.conversations.xmpp.stanzas.MessagePacket;
 17
 18public class MessageParser extends AbstractParser implements
 19		OnMessagePacketReceived {
 20
 21	private long lastCarbonMessageReceived = -(Config.CARBON_GRACE_PERIOD * 1000);
 22
 23	public MessageParser(XmppConnectionService service) {
 24		super(service);
 25	}
 26
 27	private Message parseChat(MessagePacket packet, Account account) {
 28		String[] fromParts = packet.getFrom().split("/",2);
 29		Conversation conversation = mXmppConnectionService
 30				.findOrCreateConversation(account, fromParts[0], false);
 31		conversation.setLatestMarkableMessageId(getMarkableMessageId(packet));
 32		updateLastseen(packet, account, true);
 33		String pgpBody = getPgpBody(packet);
 34		Message finishedMessage;
 35		if (pgpBody != null) {
 36			finishedMessage = new Message(conversation, packet.getFrom(),
 37					pgpBody, Message.ENCRYPTION_PGP, Message.STATUS_RECEIVED);
 38		} else {
 39			finishedMessage = new Message(conversation, packet.getFrom(),
 40					packet.getBody(), Message.ENCRYPTION_NONE,
 41					Message.STATUS_RECEIVED);
 42		}
 43		finishedMessage.setRemoteMsgId(packet.getId());
 44		if (conversation.getMode() == Conversation.MODE_MULTI
 45				&& fromParts.length >= 2) {
 46			finishedMessage.setType(Message.TYPE_PRIVATE);
 47			finishedMessage.setPresence(fromParts[1]);
 48			finishedMessage.setTrueCounterpart(conversation.getMucOptions()
 49					.getTrueCounterpart(fromParts[1]));
 50			if (conversation.hasDuplicateMessage(finishedMessage)) {
 51				return null;
 52			}
 53
 54		}
 55		finishedMessage.setTime(getTimestamp(packet));
 56		return finishedMessage;
 57	}
 58
 59	private Message parseOtrChat(MessagePacket packet, Account account) {
 60		boolean properlyAddressed = (packet.getTo().split("/",2).length == 2)
 61				|| (account.countPresences() == 1);
 62		String[] fromParts = packet.getFrom().split("/",2);
 63		Conversation conversation = mXmppConnectionService
 64				.findOrCreateConversation(account, fromParts[0], false);
 65		String presence;
 66		if (fromParts.length >= 2) {
 67			presence = fromParts[1];
 68		} else {
 69			presence = "";
 70		}
 71		updateLastseen(packet, account, true);
 72		String body = packet.getBody();
 73		if (body.matches("^\\?OTRv\\d*\\?")) {
 74			conversation.resetOtrSession();
 75		}
 76		if (!conversation.hasValidOtrSession()) {
 77			if (properlyAddressed) {
 78				conversation.startOtrSession(mXmppConnectionService, presence,
 79						false);
 80			} else {
 81				return null;
 82			}
 83		} else {
 84			String foreignPresence = conversation.getOtrSession()
 85					.getSessionID().getUserID();
 86			if (!foreignPresence.equals(presence)) {
 87				conversation.endOtrIfNeeded();
 88				if (properlyAddressed) {
 89					conversation.startOtrSession(mXmppConnectionService,
 90							presence, false);
 91				} else {
 92					return null;
 93				}
 94			}
 95		}
 96		try {
 97			Session otrSession = conversation.getOtrSession();
 98			SessionStatus before = otrSession.getSessionStatus();
 99			body = otrSession.transformReceiving(body);
100			SessionStatus after = otrSession.getSessionStatus();
101			if ((before != after) && (after == SessionStatus.ENCRYPTED)) {
102				mXmppConnectionService.onOtrSessionEstablished(conversation);
103			} else if ((before != after) && (after == SessionStatus.FINISHED)) {
104				conversation.resetOtrSession();
105				mXmppConnectionService.updateConversationUi();
106			}
107			if ((body == null) || (body.isEmpty())) {
108				return null;
109			}
110			if (body.startsWith(CryptoHelper.FILETRANSFER)) {
111				String key = body.substring(CryptoHelper.FILETRANSFER.length());
112				conversation.setSymmetricKey(CryptoHelper.hexToBytes(key));
113				return null;
114			}
115			conversation
116					.setLatestMarkableMessageId(getMarkableMessageId(packet));
117			Message finishedMessage = new Message(conversation,
118					packet.getFrom(), body, Message.ENCRYPTION_OTR,
119					Message.STATUS_RECEIVED);
120			finishedMessage.setTime(getTimestamp(packet));
121			finishedMessage.setRemoteMsgId(packet.getId());
122			return finishedMessage;
123		} catch (Exception e) {
124			String receivedId = packet.getId();
125			if (receivedId != null) {
126				mXmppConnectionService.replyWithNotAcceptable(account, packet);
127			}
128			conversation.resetOtrSession();
129			return null;
130		}
131	}
132
133	private Message parseGroupchat(MessagePacket packet, Account account) {
134		int status;
135		String[] fromParts = packet.getFrom().split("/",2);
136		if (mXmppConnectionService.find(account.pendingConferenceLeaves,
137				account, fromParts[0]) != null) {
138			return null;
139		}
140		Conversation conversation = mXmppConnectionService
141				.findOrCreateConversation(account, fromParts[0], true);
142		if (packet.hasChild("subject")) {
143			conversation.getMucOptions().setSubject(
144					packet.findChild("subject").getContent());
145			mXmppConnectionService.updateConversationUi();
146			return null;
147		}
148		if ((fromParts.length == 1)) {
149			return null;
150		}
151		String counterPart = fromParts[1];
152		if (counterPart.equals(conversation.getMucOptions().getActualNick())) {
153			if (mXmppConnectionService.markMessage(conversation,
154					packet.getId(), Message.STATUS_SEND)) {
155				return null;
156			} else {
157				status = Message.STATUS_SEND;
158			}
159		} else {
160			status = Message.STATUS_RECEIVED;
161		}
162		String pgpBody = getPgpBody(packet);
163		conversation.setLatestMarkableMessageId(getMarkableMessageId(packet));
164		Message finishedMessage;
165		if (pgpBody == null) {
166			finishedMessage = new Message(conversation, counterPart,
167					packet.getBody(), Message.ENCRYPTION_NONE, status);
168		} else {
169			finishedMessage = new Message(conversation, counterPart, pgpBody,
170					Message.ENCRYPTION_PGP, status);
171		}
172		finishedMessage.setRemoteMsgId(packet.getId());
173		if (status == Message.STATUS_RECEIVED) {
174			finishedMessage.setTrueCounterpart(conversation.getMucOptions()
175					.getTrueCounterpart(counterPart));
176		}
177		if (packet.hasChild("delay")
178				&& conversation.hasDuplicateMessage(finishedMessage)) {
179			return null;
180		}
181		finishedMessage.setTime(getTimestamp(packet));
182		return finishedMessage;
183	}
184
185	private Message parseCarbonMessage(MessagePacket packet, Account account) {
186		int status;
187		String fullJid;
188		Element forwarded;
189		if (packet.hasChild("received", "urn:xmpp:carbons:2")) {
190			forwarded = packet.findChild("received", "urn:xmpp:carbons:2")
191				.findChild("forwarded", "urn:xmpp:forward:0");
192			status = Message.STATUS_RECEIVED;
193		} else if (packet.hasChild("sent", "urn:xmpp:carbons:2")) {
194			forwarded = packet.findChild("sent", "urn:xmpp:carbons:2")
195				.findChild("forwarded", "urn:xmpp:forward:0");
196			status = Message.STATUS_SEND;
197		} else {
198			return null;
199		}
200		if (forwarded == null) {
201			return null;
202		}
203		Element message = forwarded.findChild("message");
204		if ((message == null) || (!message.hasChild("body"))) {
205			if (status == Message.STATUS_RECEIVED
206					&& message.getAttribute("from") != null) {
207				parseNonMessage(message, account);
208			}
209			return null;
210		}
211		if (status == Message.STATUS_RECEIVED) {
212			fullJid = message.getAttribute("from");
213			if (fullJid == null) {
214				return null;
215			} else {
216				updateLastseen(message, account, true);
217			}
218		} else {
219			fullJid = message.getAttribute("to");
220			if (fullJid == null) {
221				return null;
222			}
223		}
224		String[] parts = fullJid.split("/",2);
225		Conversation conversation = mXmppConnectionService
226				.findOrCreateConversation(account, parts[0], false);
227		conversation.setLatestMarkableMessageId(getMarkableMessageId(packet));
228
229		String pgpBody = getPgpBody(message);
230		Message finishedMessage;
231		if (pgpBody != null) {
232			finishedMessage = new Message(conversation, fullJid, pgpBody,
233					Message.ENCRYPTION_PGP, status);
234		} else {
235			String body = message.findChild("body").getContent();
236			finishedMessage = new Message(conversation, fullJid, body,
237					Message.ENCRYPTION_NONE, status);
238		}
239		finishedMessage.setTime(getTimestamp(message));
240		finishedMessage.setRemoteMsgId(message.getAttribute("id"));
241		if (conversation.getMode() == Conversation.MODE_MULTI
242				&& parts.length >= 2) {
243			finishedMessage.setType(Message.TYPE_PRIVATE);
244			finishedMessage.setPresence(parts[1]);
245			finishedMessage.setTrueCounterpart(conversation.getMucOptions()
246					.getTrueCounterpart(parts[1]));
247			if (conversation.hasDuplicateMessage(finishedMessage)) {
248				return null;
249			}
250		}
251
252		return finishedMessage;
253	}
254
255	private void parseError(MessagePacket packet, Account account) {
256		String[] fromParts = packet.getFrom().split("/",2);
257		mXmppConnectionService.markMessage(account, fromParts[0],
258				packet.getId(), Message.STATUS_SEND_FAILED);
259	}
260
261	private void parseNonMessage(Element packet, Account account) {
262		if (packet.hasChild("event", "http://jabber.org/protocol/pubsub#event")) {
263			Element event = packet.findChild("event",
264					"http://jabber.org/protocol/pubsub#event");
265			parseEvent(event, packet.getAttribute("from"), account);
266		} else if (packet.hasChild("displayed", "urn:xmpp:chat-markers:0")) {
267			String id = packet
268					.findChild("displayed", "urn:xmpp:chat-markers:0")
269					.getAttribute("id");
270			String[] fromParts = packet.getAttribute("from").split("/",2);
271			updateLastseen(packet, account, true);
272			mXmppConnectionService.markMessage(account, fromParts[0], id,
273					Message.STATUS_SEND_DISPLAYED);
274		} else if (packet.hasChild("received", "urn:xmpp:chat-markers:0")) {
275			String id = packet.findChild("received", "urn:xmpp:chat-markers:0")
276					.getAttribute("id");
277			String[] fromParts = packet.getAttribute("from").split("/",2);
278			updateLastseen(packet, account, false);
279			mXmppConnectionService.markMessage(account, fromParts[0], id,
280					Message.STATUS_SEND_RECEIVED);
281		} else if (packet.hasChild("x", "http://jabber.org/protocol/muc#user")) {
282			Element x = packet.findChild("x",
283					"http://jabber.org/protocol/muc#user");
284			if (x.hasChild("invite")) {
285				Conversation conversation = mXmppConnectionService
286						.findOrCreateConversation(account,
287								packet.getAttribute("from"), true);
288				if (!conversation.getMucOptions().online()) {
289					if (x.hasChild("password")) {
290						Element password = x.findChild("password");
291						conversation.getMucOptions().setPassword(
292								password.getContent());
293					}
294					mXmppConnectionService.joinMuc(conversation);
295					mXmppConnectionService.updateConversationUi();
296				}
297			}
298		} else if (packet.hasChild("x", "jabber:x:conference")) {
299			Element x = packet.findChild("x", "jabber:x:conference");
300			String jid = x.getAttribute("jid");
301			String password = x.getAttribute("password");
302			if (jid != null) {
303				Conversation conversation = mXmppConnectionService
304						.findOrCreateConversation(account, jid, true);
305				if (!conversation.getMucOptions().online()) {
306					if (password != null) {
307						conversation.getMucOptions().setPassword(password);
308					}
309					mXmppConnectionService.joinMuc(conversation);
310					mXmppConnectionService.updateConversationUi();
311				}
312			}
313		}
314	}
315
316	private void parseEvent(Element event, String from, Account account) {
317		Element items = event.findChild("items");
318		String node = items.getAttribute("node");
319		if (node != null) {
320			if (node.equals("urn:xmpp:avatar:metadata")) {
321				Avatar avatar = Avatar.parseMetadata(items);
322				if (avatar != null) {
323					avatar.owner = from;
324					if (mXmppConnectionService.getFileBackend().isAvatarCached(
325							avatar)) {
326						if (account.getJid().equals(from)) {
327							if (account.setAvatar(avatar.getFilename())) {
328								mXmppConnectionService.databaseBackend
329										.updateAccount(account);
330							}
331						} else {
332							Contact contact = account.getRoster().getContact(
333									from);
334							contact.setAvatar(avatar.getFilename());
335						}
336					} else {
337						mXmppConnectionService.fetchAvatar(account, avatar);
338					}
339				}
340			} else if (node.equals("http://jabber.org/protocol/nick")) {
341				Element item = items.findChild("item");
342				if (item != null) {
343					Element nick = item.findChild("nick",
344							"http://jabber.org/protocol/nick");
345					if (nick != null) {
346						if (from != null) {
347							Contact contact = account.getRoster().getContact(
348									from);
349							contact.setPresenceName(nick.getContent());
350						}
351					}
352				}
353			}
354		}
355	}
356
357	private String getPgpBody(Element message) {
358		Element child = message.findChild("x", "jabber:x:encrypted");
359		if (child == null) {
360			return null;
361		} else {
362			return child.getContent();
363		}
364	}
365
366	private String getMarkableMessageId(Element message) {
367		if (message.hasChild("markable", "urn:xmpp:chat-markers:0")) {
368			return message.getAttribute("id");
369		} else {
370			return null;
371		}
372	}
373
374	@Override
375	public void onMessagePacketReceived(Account account, MessagePacket packet) {
376		Message message = null;
377		boolean notify = true;
378		if (mXmppConnectionService.getPreferences().getBoolean(
379				"notification_grace_period_after_carbon_received", true)) {
380			notify = (SystemClock.elapsedRealtime() - lastCarbonMessageReceived) > (Config.CARBON_GRACE_PERIOD * 1000);
381		}
382
383		this.parseNick(packet, account);
384
385		if ((packet.getType() == MessagePacket.TYPE_CHAT || packet.getType() == MessagePacket.TYPE_NORMAL)) {
386			if ((packet.getBody() != null)
387					&& (packet.getBody().startsWith("?OTR"))) {
388				message = this.parseOtrChat(packet, account);
389				if (message != null) {
390					message.markUnread();
391				}
392			} else if (packet.hasChild("body")) {
393				message = this.parseChat(packet, account);
394				if (message != null) {
395					message.markUnread();
396				}
397			} else if (packet.hasChild("received", "urn:xmpp:carbons:2")
398					|| (packet.hasChild("sent", "urn:xmpp:carbons:2"))) {
399				message = this.parseCarbonMessage(packet, account);
400				if (message != null) {
401					if (message.getStatus() == Message.STATUS_SEND) {
402						lastCarbonMessageReceived = SystemClock
403								.elapsedRealtime();
404						notify = false;
405						message.getConversation().markRead();
406					} else {
407						message.markUnread();
408					}
409				}
410			} else {
411				parseNonMessage(packet, account);
412			}
413		} else if (packet.getType() == MessagePacket.TYPE_GROUPCHAT) {
414			message = this.parseGroupchat(packet, account);
415			if (message != null) {
416				if (message.getStatus() == Message.STATUS_RECEIVED) {
417					message.markUnread();
418				} else {
419					message.getConversation().markRead();
420					lastCarbonMessageReceived = SystemClock.elapsedRealtime();
421					notify = false;
422				}
423			}
424		} else if (packet.getType() == MessagePacket.TYPE_ERROR) {
425			this.parseError(packet, account);
426			return;
427		} else if (packet.getType() == MessagePacket.TYPE_HEADLINE) {
428			this.parseHeadline(packet, account);
429			return;
430		}
431		if ((message == null) || (message.getBody() == null)) {
432			return;
433		}
434		if ((mXmppConnectionService.confirmMessages())
435				&& ((packet.getId() != null))) {
436			if (packet.hasChild("markable", "urn:xmpp:chat-markers:0")) {
437				MessagePacket receipt = mXmppConnectionService
438						.getMessageGenerator().received(account, packet,
439								"urn:xmpp:chat-markers:0");
440				mXmppConnectionService.sendMessagePacket(account, receipt);
441			}
442			if (packet.hasChild("request", "urn:xmpp:receipts")) {
443				MessagePacket receipt = mXmppConnectionService
444						.getMessageGenerator().received(account, packet,
445								"urn:xmpp:receipts");
446				mXmppConnectionService.sendMessagePacket(account, receipt);
447			}
448		}
449		Conversation conversation = message.getConversation();
450		conversation.getMessages().add(message);
451		if (packet.getType() != MessagePacket.TYPE_ERROR) {
452			if (message.getEncryption() == Message.ENCRYPTION_NONE
453					|| mXmppConnectionService.saveEncryptedMessages()) {
454				mXmppConnectionService.databaseBackend.createMessage(message);
455			}
456		}
457		notify = notify && !conversation.isMuted();
458		mXmppConnectionService.notifyUi(conversation, notify);
459	}
460
461	private void parseHeadline(MessagePacket packet, Account account) {
462		if (packet.hasChild("event", "http://jabber.org/protocol/pubsub#event")) {
463			Element event = packet.findChild("event",
464					"http://jabber.org/protocol/pubsub#event");
465			parseEvent(event, packet.getFrom(), account);
466		}
467	}
468
469	private void parseNick(MessagePacket packet, Account account) {
470		Element nick = packet.findChild("nick",
471				"http://jabber.org/protocol/nick");
472		if (nick != null) {
473			if (packet.getFrom() != null) {
474				Contact contact = account.getRoster().getContact(
475						packet.getFrom());
476				contact.setPresenceName(nick.getContent());
477			}
478		}
479	}
480}