MessageParser.java

  1package eu.siacs.conversations.parser;
  2
  3import android.os.SystemClock;
  4import android.util.Log;
  5import net.java.otr4j.session.Session;
  6import net.java.otr4j.session.SessionStatus;
  7import eu.siacs.conversations.Config;
  8import eu.siacs.conversations.entities.Account;
  9import eu.siacs.conversations.entities.Contact;
 10import eu.siacs.conversations.entities.Conversation;
 11import eu.siacs.conversations.entities.Message;
 12import eu.siacs.conversations.services.XmppConnectionService;
 13import eu.siacs.conversations.utils.CryptoHelper;
 14import eu.siacs.conversations.xml.Element;
 15import eu.siacs.conversations.xmpp.OnMessagePacketReceived;
 16import eu.siacs.conversations.xmpp.pep.Avatar;
 17import eu.siacs.conversations.xmpp.stanzas.MessagePacket;
 18
 19public class MessageParser extends AbstractParser implements
 20		OnMessagePacketReceived {
 21
 22	private long lastCarbonMessageReceived = -(Config.CARBON_GRACE_PERIOD * 1000);
 23
 24	public MessageParser(XmppConnectionService service) {
 25		super(service);
 26	}
 27
 28	private Message parseChat(MessagePacket packet, Account account) {
 29		String[] fromParts = packet.getFrom().split("/");
 30		Conversation conversation = mXmppConnectionService
 31				.findOrCreateConversation(account, fromParts[0], false);
 32		conversation.setLatestMarkableMessageId(getMarkableMessageId(packet));
 33		updateLastseen(packet, account, true);
 34		String pgpBody = getPgpBody(packet);
 35		Message finishedMessage;
 36		if (pgpBody != null) {
 37			finishedMessage = new Message(conversation, packet.getFrom(),
 38					pgpBody, Message.ENCRYPTION_PGP, Message.STATUS_RECEIVED);
 39		} else {
 40			finishedMessage = new Message(conversation, packet.getFrom(),
 41					packet.getBody(), Message.ENCRYPTION_NONE,
 42					Message.STATUS_RECEIVED);
 43		}
 44		finishedMessage.setRemoteMsgId(packet.getId());
 45		if (conversation.getMode() == Conversation.MODE_MULTI
 46				&& fromParts.length >= 2) {
 47			finishedMessage.setType(Message.TYPE_PRIVATE);
 48			finishedMessage.setPresence(fromParts[1]);
 49			finishedMessage.setTrueCounterpart(conversation.getMucOptions()
 50					.getTrueCounterpart(fromParts[1]));
 51			if (conversation.hasDuplicateMessage(finishedMessage)) {
 52				return null;
 53			}
 54
 55		}
 56		finishedMessage.setTime(getTimestamp(packet));
 57		return finishedMessage;
 58	}
 59
 60	private Message parseOtrChat(MessagePacket packet, Account account) {
 61		boolean properlyAddressed = (packet.getTo().split("/").length == 2)
 62				|| (account.countPresences() == 1);
 63		String[] fromParts = packet.getFrom().split("/");
 64		Conversation conversation = mXmppConnectionService
 65				.findOrCreateConversation(account, fromParts[0], false);
 66		String presence;
 67		if (fromParts.length >= 2) {
 68			presence = fromParts[1];
 69		} else {
 70			presence = "";
 71		}
 72		updateLastseen(packet, account, true);
 73		String body = packet.getBody();
 74		if (!conversation.hasValidOtrSession()) {
 75			if (properlyAddressed) {
 76				conversation.startOtrSession(
 77						mXmppConnectionService.getApplicationContext(),
 78						presence, false);
 79			} else {
 80				return null;
 81			}
 82		} else {
 83			String foreignPresence = conversation.getOtrSession()
 84					.getSessionID().getUserID();
 85			if (!foreignPresence.equals(presence)) {
 86				conversation.endOtrIfNeeded();
 87				if (properlyAddressed) {
 88					conversation.startOtrSession(
 89							mXmppConnectionService.getApplicationContext(),
 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.endOtrIfNeeded();
129			return null;
130		}
131	}
132
133	private Message parseGroupchat(MessagePacket packet, Account account) {
134		int status;
135		String[] fromParts = packet.getFrom().split("/");
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")) {
190			forwarded = packet.findChild("received").findChild("forwarded");
191			status = Message.STATUS_RECEIVED;
192		} else if (packet.hasChild("sent")) {
193			forwarded = packet.findChild("sent").findChild("forwarded");
194			status = Message.STATUS_SEND;
195		} else {
196			return null;
197		}
198		if (forwarded == null) {
199			return null;
200		}
201		Element message = forwarded.findChild("message");
202		if ((message == null) || (!message.hasChild("body"))) {
203			if (status == Message.STATUS_RECEIVED
204					&& message.getAttribute("from") != null) {
205				parseNormal(message, account);
206			}
207			return null;
208		}
209		if (status == Message.STATUS_RECEIVED) {
210			fullJid = message.getAttribute("from");
211			if (fullJid == null) {
212				return null;
213			} else {
214				updateLastseen(message, account, true);
215			}
216		} else {
217			fullJid = message.getAttribute("to");
218			if (fullJid == null) {
219				return null;
220			}
221		}
222		String[] parts = fullJid.split("/");
223		Conversation conversation = mXmppConnectionService
224				.findOrCreateConversation(account, parts[0], false);
225		conversation.setLatestMarkableMessageId(getMarkableMessageId(packet));
226
227		String pgpBody = getPgpBody(message);
228		Message finishedMessage;
229		if (pgpBody != null) {
230			finishedMessage = new Message(conversation, fullJid, pgpBody,
231					Message.ENCRYPTION_PGP, status);
232		} else {
233			String body = message.findChild("body").getContent();
234			finishedMessage = new Message(conversation, fullJid, body,
235					Message.ENCRYPTION_NONE, status);
236		}
237		finishedMessage.setTime(getTimestamp(message));
238		finishedMessage.setRemoteMsgId(message.getAttribute("id"));
239		if (conversation.getMode() == Conversation.MODE_MULTI
240				&& parts.length >= 2) {
241			finishedMessage.setType(Message.TYPE_PRIVATE);
242			finishedMessage.setPresence(parts[1]);
243			finishedMessage.setTrueCounterpart(conversation.getMucOptions()
244					.getTrueCounterpart(parts[1]));
245			if (conversation.hasDuplicateMessage(finishedMessage)) {
246				return null;
247			}
248		}
249
250		return finishedMessage;
251	}
252
253	private void parseError(MessagePacket packet, Account account) {
254		String[] fromParts = packet.getFrom().split("/");
255		mXmppConnectionService.markMessage(account, fromParts[0],
256				packet.getId(), Message.STATUS_SEND_FAILED);
257	}
258
259	private void parseNormal(Element packet, Account account) {
260		if (packet.hasChild("event", "http://jabber.org/protocol/pubsub#event")) {
261			Element event = packet.findChild("event",
262					"http://jabber.org/protocol/pubsub#event");
263			parseEvent(event, packet.getAttribute("from"), account);
264		}
265		if (packet.hasChild("displayed", "urn:xmpp:chat-markers:0")) {
266			String id = packet
267					.findChild("displayed", "urn:xmpp:chat-markers:0")
268					.getAttribute("id");
269			String[] fromParts = packet.getAttribute("from").split("/");
270			updateLastseen(packet, account, true);
271			mXmppConnectionService.markMessage(account, fromParts[0], id,
272					Message.STATUS_SEND_DISPLAYED);
273		} else if (packet.hasChild("received", "urn:xmpp:chat-markers:0")) {
274			String id = packet.findChild("received", "urn:xmpp:chat-markers:0")
275					.getAttribute("id");
276			String[] fromParts = packet.getAttribute("from").split("/");
277			updateLastseen(packet, account, false);
278			mXmppConnectionService.markMessage(account, fromParts[0], id,
279					Message.STATUS_SEND_RECEIVED);
280		} else if (packet.hasChild("x", "http://jabber.org/protocol/muc#user")) {
281			Element x = packet.findChild("x",
282					"http://jabber.org/protocol/muc#user");
283			if (x.hasChild("invite")) {
284				Conversation conversation = mXmppConnectionService
285						.findOrCreateConversation(account,
286								packet.getAttribute("from"), true);
287				if (!conversation.getMucOptions().online()) {
288					mXmppConnectionService.joinMuc(conversation);
289					mXmppConnectionService.updateConversationUi();
290				}
291			}
292
293		} else if (packet.hasChild("x", "jabber:x:conference")) {
294			Element x = packet.findChild("x", "jabber:x:conference");
295			String jid = x.getAttribute("jid");
296			if (jid != null) {
297				Conversation conversation = mXmppConnectionService
298						.findOrCreateConversation(account, jid, true);
299				if (!conversation.getMucOptions().online()) {
300					mXmppConnectionService.joinMuc(conversation);
301					mXmppConnectionService.updateConversationUi();
302				}
303			}
304		}
305	}
306
307	private void parseEvent(Element event, String from, Account account) {
308		Element items = event.findChild("items");
309		String node = items.getAttribute("node");
310		if (node != null) {
311			if (node.equals("urn:xmpp:avatar:metadata")) {
312				Avatar avatar = Avatar.parseMetadata(items);
313				if (avatar != null) {
314					avatar.owner = from;
315					if (mXmppConnectionService.getFileBackend().isAvatarCached(
316							avatar)) {
317						if (account.getJid().equals(from)) {
318							if (account.setAvatar(avatar.getFilename())) {
319								mXmppConnectionService.databaseBackend
320										.updateAccount(account);
321							}
322						} else {
323							Contact contact = account.getRoster().getContact(
324									from);
325							contact.setAvatar(avatar.getFilename());
326						}
327					} else {
328						mXmppConnectionService.fetchAvatar(account, avatar);
329					}
330				}
331			} else {
332				Log.d(Config.LOGTAG, account.getJid() + ": " + node + " from "
333						+ from);
334			}
335		} else {
336			Log.d(Config.LOGTAG, event.toString());
337		}
338	}
339
340	private String getPgpBody(Element message) {
341		Element child = message.findChild("x", "jabber:x:encrypted");
342		if (child == null) {
343			return null;
344		} else {
345			return child.getContent();
346		}
347	}
348
349	private String getMarkableMessageId(Element message) {
350		if (message.hasChild("markable", "urn:xmpp:chat-markers:0")) {
351			return message.getAttribute("id");
352		} else {
353			return null;
354		}
355	}
356
357	@Override
358	public void onMessagePacketReceived(Account account, MessagePacket packet) {
359		Message message = null;
360		boolean notify = true;
361		if (mXmppConnectionService.getPreferences().getBoolean(
362				"notification_grace_period_after_carbon_received", true)) {
363			notify = (SystemClock.elapsedRealtime() - lastCarbonMessageReceived) > (Config.CARBON_GRACE_PERIOD * 1000);
364		}
365
366		if ((packet.getType() == MessagePacket.TYPE_CHAT)) {
367			if ((packet.getBody() != null)
368					&& (packet.getBody().startsWith("?OTR"))) {
369				message = this.parseOtrChat(packet, account);
370				if (message != null) {
371					message.markUnread();
372				}
373			} else if (packet.hasChild("body")) {
374				message = this.parseChat(packet, account);
375				if (message != null) {
376					message.markUnread();
377				}
378			} else if (packet.hasChild("received") || (packet.hasChild("sent"))) {
379				message = this.parseCarbonMessage(packet, account);
380				if (message != null) {
381					if (message.getStatus() == Message.STATUS_SEND) {
382						lastCarbonMessageReceived = SystemClock
383								.elapsedRealtime();
384						notify = false;
385						message.getConversation().markRead();
386					} else {
387						message.markUnread();
388					}
389				}
390			} else {
391				parseNormal(packet, account);
392			}
393
394		} else if (packet.getType() == MessagePacket.TYPE_GROUPCHAT) {
395			message = this.parseGroupchat(packet, account);
396			if (message != null) {
397				if (message.getStatus() == Message.STATUS_RECEIVED) {
398					message.markUnread();
399				} else {
400					message.getConversation().markRead();
401					lastCarbonMessageReceived = SystemClock.elapsedRealtime();
402					notify = false;
403				}
404			}
405		} else if (packet.getType() == MessagePacket.TYPE_ERROR) {
406			this.parseError(packet, account);
407			return;
408		} else if (packet.getType() == MessagePacket.TYPE_NORMAL) {
409			this.parseNormal(packet, account);
410			return;
411		} else if (packet.getType() == MessagePacket.TYPE_HEADLINE) {
412			this.parseHeadline(packet, account);
413			return;
414		}
415		if ((message == null) || (message.getBody() == null)) {
416			return;
417		}
418		if ((mXmppConnectionService.confirmMessages())
419				&& ((packet.getId() != null))) {
420			if (packet.hasChild("markable", "urn:xmpp:chat-markers:0")) {
421				MessagePacket receipt = mXmppConnectionService
422						.getMessageGenerator().received(account, packet,
423								"urn:xmpp:chat-markers:0");
424				mXmppConnectionService.sendMessagePacket(account, receipt);
425			}
426			if (packet.hasChild("request", "urn:xmpp:receipts")) {
427				MessagePacket receipt = mXmppConnectionService
428						.getMessageGenerator().received(account, packet,
429								"urn:xmpp:receipts");
430				mXmppConnectionService.sendMessagePacket(account, receipt);
431			}
432		}
433		Conversation conversation = message.getConversation();
434		conversation.getMessages().add(message);
435		if (packet.getType() != MessagePacket.TYPE_ERROR) {
436			mXmppConnectionService.databaseBackend.createMessage(message);
437		}
438		notify = notify && !conversation.isMuted();
439		mXmppConnectionService.notifyUi(conversation, notify);
440	}
441
442	private void parseHeadline(MessagePacket packet, Account account) {
443		if (packet.hasChild("event", "http://jabber.org/protocol/pubsub#event")) {
444			Element event = packet.findChild("event",
445					"http://jabber.org/protocol/pubsub#event");
446			parseEvent(event, packet.getFrom(), account);
447		}
448	}
449}