Merge branch 'highlight-regex'

8 files changed, 175 insertions, 26 deletions

diff --git a/libempathy-gtk/empathy-chat-text-view.c b/libempathy-gtk/empathy-chat-text-view.c
index c251f1f42..60d642ccb 100644
--- a/libempathy-gtk/empathy-chat-text-view.c
+++ b/libempathy-gtk/empathy-chat-text-view.c
@@ -717,7 +717,8 @@ chat_text_view_scroll_down (EmpathyChatView *view)
 
 static void
 chat_text_view_append_message (EmpathyChatView *view,
-			       EmpathyMessage  *msg)
+			       EmpathyMessage  *msg,
+			       gboolean         should_highlight)
 {
 	EmpathyChatTextView     *text_view = EMPATHY_CHAT_TEXT_VIEW (view);
 	EmpathyChatTextViewPriv *priv = GET_PRIV (text_view);
@@ -739,7 +740,8 @@ chat_text_view_append_message (EmpathyChatView *view,
 	chat_text_maybe_append_date_and_time (text_view, timestamp);
 	if (EMPATHY_CHAT_TEXT_VIEW_GET_CLASS (view)->append_message) {
 		EMPATHY_CHAT_TEXT_VIEW_GET_CLASS (view)->append_message (text_view,
-									 msg);
+									 msg,
+									 should_highlight);
 	}
 
 	if (bottom) {
diff --git a/libempathy-gtk/empathy-chat-text-view.h b/libempathy-gtk/empathy-chat-text-view.h
index 12edbcc64..ce83fd2fa 100644
--- a/libempathy-gtk/empathy-chat-text-view.h
+++ b/libempathy-gtk/empathy-chat-text-view.h
@@ -56,7 +56,8 @@ struct _EmpathyChatTextViewClass {
 
 	/* <vtable> */
 	void (*append_message) (EmpathyChatTextView *view,
-				EmpathyMessage      *message);
+				EmpathyMessage      *message,
+				gboolean             should_highlight);
 };
 
 #define EMPATHY_CHAT_TEXT_VIEW_TAG_CUT "cut"
diff --git a/libempathy-gtk/empathy-chat-view.c b/libempathy-gtk/empathy-chat-view.c
index 088b12084..f5d6ddf09 100644
--- a/libempathy-gtk/empathy-chat-view.c
+++ b/libempathy-gtk/empathy-chat-view.c
@@ -61,13 +61,15 @@ chat_view_base_init (gpointer klass)
 
 void
 empathy_chat_view_append_message (EmpathyChatView *view,
-				  EmpathyMessage  *msg)
+				  EmpathyMessage  *msg,
+				  gboolean         should_highlight)
 {
 	g_return_if_fail (EMPATHY_IS_CHAT_VIEW (view));
 
 	if (EMPATHY_TYPE_CHAT_VIEW_GET_IFACE (view)->append_message) {
 		EMPATHY_TYPE_CHAT_VIEW_GET_IFACE (view)->append_message (view,
-									 msg);
+									 msg,
+									 should_highlight);
 	}
 }
 
diff --git a/libempathy-gtk/empathy-chat-view.h b/libempathy-gtk/empathy-chat-view.h
index bc9e91761..2c47e0429 100644
--- a/libempathy-gtk/empathy-chat-view.h
+++ b/libempathy-gtk/empathy-chat-view.h
@@ -43,7 +43,8 @@ struct _EmpathyChatViewIface {
 
 	/* VTabled */
 	void             (*append_message)       (EmpathyChatView *view,
-						  EmpathyMessage  *msg);
+						  EmpathyMessage  *msg,
+						  gboolean         should_highlight);
 	void             (*append_event)         (EmpathyChatView *view,
 						  const gchar     *str);
 	void             (*append_event_markup)  (EmpathyChatView *view,
@@ -81,7 +82,8 @@ struct _EmpathyChatViewIface {
 
 GType            empathy_chat_view_get_type             (void) G_GNUC_CONST;
 void             empathy_chat_view_append_message       (EmpathyChatView *view,
-							 EmpathyMessage  *msg);
+							 EmpathyMessage  *msg,
+							 gboolean         should_highlight);
 void             empathy_chat_view_append_event         (EmpathyChatView *view,
 							 const gchar     *str);
 void             empathy_chat_view_append_event_markup  (EmpathyChatView *view,
diff --git a/libempathy-gtk/empathy-chat.c b/libempathy-gtk/empathy-chat.c
index be5d71ec7..81350220b 100644
--- a/libempathy-gtk/empathy-chat.c
+++ b/libempathy-gtk/empathy-chat.c
@@ -73,6 +73,7 @@ struct _EmpathyChatPriv {
 	gchar             *id;
 	gchar             *name;
 	gchar             *subject;
+	EmpathyContact    *self_contact;
 	EmpathyContact    *remote_contact;
 	gboolean           show_contacts;
 
@@ -155,6 +156,10 @@ struct _EmpathyChatPriv {
 	 * the keyboard or the mouse. We can't ask GTK for the most recent
 	 * event, because it will be a notify event. Instead we track it here */
 	GdkEventType       most_recent_event_type;
+
+	/* A regex matching our own current nickname in the room, or %NULL if
+	 * !empathy_chat_is_room(). */
+	GRegex            *highlight_regex;
 };
 
 typedef struct {
@@ -896,14 +901,12 @@ chat_command_me (EmpathyChat *chat,
 	if (!tp_text_channel_supports_message_type (channel,
 			TP_CHANNEL_TEXT_MESSAGE_TYPE_ACTION)) {
 		/* Action message are not supported, 'simulate' the action */
-		EmpathyContact *self_contact;
 		gchar *tmp;
 
-		self_contact = empathy_tp_chat_get_self_contact (priv->tp_chat);
 		/* The TpChat can't be ready if it doesn't have the self contact */
-		g_assert (self_contact != NULL);
+		g_assert (priv->self_contact != NULL);
 
-		tmp = g_strdup_printf ("%s %s", empathy_contact_get_alias (self_contact),
+		tmp = g_strdup_printf ("%s %s", empathy_contact_get_alias (priv->self_contact),
 			strv[1]);
 		message = tp_client_message_new_text (TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL,
 			tmp);
@@ -1383,6 +1386,86 @@ chat_state_changed_cb (EmpathyTpChat      *tp_chat,
 	}
 }
 
+static GRegex *
+get_highlight_regex_for (const gchar *name)
+{
+	GRegex *regex;
+	gchar *name_esc, *pattern;
+	GError *error = NULL;
+
+	name_esc = g_regex_escape_string (name, -1);
+	pattern = g_strdup_printf ("\\b%s\\b", name_esc);
+	regex = g_regex_new (pattern, G_REGEX_CASELESS | G_REGEX_OPTIMIZE, 0,
+		&error);
+
+	if (regex == NULL) {
+		DEBUG ("couldn't compile regex /%s/: %s", pattern,
+			error->message);
+
+		g_error_free (error);
+	}
+
+	g_free (pattern);
+	g_free (name_esc);
+
+	return regex;
+}
+
+/* Called when priv->self_contact changes, or priv->self_contact:alias changes.
+ * Only connected if empathy_chat_is_room() is TRUE, for obvious-ish reasons.
+ */
+static void
+chat_self_contact_alias_changed_cb (EmpathyChat *chat)
+{
+	EmpathyChatPriv *priv = GET_PRIV (chat);
+
+	tp_clear_pointer (&priv->highlight_regex, g_regex_unref);
+
+	if (priv->self_contact != NULL) {
+		const gchar *alias = empathy_contact_get_alias (priv->self_contact);
+
+		g_return_if_fail (alias != NULL);
+		priv->highlight_regex = get_highlight_regex_for (alias);
+	}
+}
+
+static gboolean
+chat_should_highlight (EmpathyChat *chat,
+	EmpathyMessage *message)
+{
+	EmpathyChatPriv *priv = GET_PRIV (chat);
+	const gchar   *msg;
+	TpChannelTextMessageFlags flags;
+
+	g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
+
+	if (!empathy_chat_is_room (chat)) {
+		return FALSE;
+	}
+
+	if (!empathy_message_is_incoming (message)) {
+		return FALSE;
+	}
+
+	msg = empathy_message_get_body (message);
+	if (!msg) {
+		return FALSE;
+	}
+
+	flags = empathy_message_get_flags (message);
+	if (flags & TP_CHANNEL_TEXT_MESSAGE_FLAG_SCROLLBACK) {
+		/* FIXME: Ideally we shouldn't highlight scrollback messages only if they
+		 * have already been received by the user before (and so are in the logs) */
+		return FALSE;
+	}
+
+	if (priv->highlight_regex == NULL) {
+		return FALSE;
+	}
+
+	return g_regex_match (priv->highlight_regex, msg, 0, NULL);
+}
+
 static void
 chat_message_received (EmpathyChat *chat,
 	EmpathyMessage *message,
@@ -1400,19 +1483,21 @@ chat_message_received (EmpathyChat *chat,
 
 		empathy_chat_view_edit_message (chat->view, message);
 	} else {
+		gboolean should_highlight = chat_should_highlight (chat, message);
 		DEBUG ("Appending new message '%s' from %s (%d)",
 			empathy_message_get_token (message),
 			empathy_contact_get_alias (sender),
 			empathy_contact_get_handle (sender));
 
-		empathy_chat_view_append_message (chat->view, message);
+		empathy_chat_view_append_message (chat->view, message, should_highlight);
 
 		if (empathy_message_is_incoming (message)) {
 			priv->unread_messages++;
 			g_object_notify (G_OBJECT (chat), "nb-unread-messages");
 		}
 
-		g_signal_emit (chat, signals[NEW_MESSAGE], 0, message, pending);
+		g_signal_emit (chat, signals[NEW_MESSAGE], 0, message, pending,
+			       should_highlight);
 	}
 
 	/* We received a message so the contact is no longer
@@ -2495,13 +2580,15 @@ got_filtered_messages_cb (GObject *manager,
 				"sender", empathy_message_get_sender (message),
 				NULL);
 
-			empathy_chat_view_append_message (chat->view, syn_msg);
+			empathy_chat_view_append_message (chat->view, syn_msg,
+							  chat_should_highlight (chat, syn_msg));
 			empathy_chat_view_edit_message (chat->view, message);
 
 			g_object_unref (syn_msg);
 		} else {
 			/* append the latest message */
-			empathy_chat_view_append_message (chat->view, message);
+			empathy_chat_view_append_message (chat->view, message,
+							  chat_should_highlight (chat, message));
 		}
 
 		g_object_unref (message);
@@ -2800,6 +2887,32 @@ empathy_chat_set_show_contacts (EmpathyChat *chat,
 }
 
 static void
+chat_self_contact_changed_cb (EmpathyChat *chat)
+{
+	EmpathyChatPriv *priv = GET_PRIV (chat);
+
+	if (priv->self_contact != NULL) {
+		g_signal_handlers_disconnect_by_func (priv->self_contact,
+						      chat_self_contact_alias_changed_cb,
+						      chat);
+	}
+	g_clear_object (&priv->self_contact);
+
+	priv->self_contact = empathy_tp_chat_get_self_contact (priv->tp_chat);
+	if (priv->self_contact != NULL) {
+		g_object_ref (priv->self_contact);
+
+		if (empathy_chat_is_room (chat)) {
+			g_signal_connect_swapped (priv->self_contact, "notify::alias",
+					  G_CALLBACK (chat_self_contact_alias_changed_cb),
+					  chat);
+		}
+	}
+
+	chat_self_contact_alias_changed_cb (chat);
+}
+
+static void
 chat_remote_contact_changed_cb (EmpathyChat *chat)
 {
 	EmpathyChatPriv *priv = GET_PRIV (chat);
@@ -3154,6 +3267,8 @@ chat_finalize (GObject *object)
 		g_signal_handlers_disconnect_by_func (priv->tp_chat,
 			chat_members_changed_cb, chat);
 		g_signal_handlers_disconnect_by_func (priv->tp_chat,
+			chat_self_contact_changed_cb, chat);
+		g_signal_handlers_disconnect_by_func (priv->tp_chat,
 			chat_remote_contact_changed_cb, chat);
 		g_signal_handlers_disconnect_by_func (priv->tp_chat,
 			chat_title_changed_cb, chat);
@@ -3165,6 +3280,12 @@ chat_finalize (GObject *object)
 	if (priv->account) {
 		g_object_unref (priv->account);
 	}
+	if (priv->self_contact) {
+		g_signal_handlers_disconnect_by_func (priv->self_contact,
+						      chat_self_contact_alias_changed_cb,
+						      chat);
+		g_object_unref (priv->self_contact);
+	}
 	if (priv->remote_contact) {
 		g_object_unref (priv->remote_contact);
 	}
@@ -3178,6 +3299,8 @@ chat_finalize (GObject *object)
 	g_free (priv->subject);
 	g_completion_free (priv->completion);
 
+	tp_clear_pointer (&priv->highlight_regex, g_regex_unref);
+
 	G_OBJECT_CLASS (empathy_chat_parent_class)->finalize (object);
 }
 
@@ -3300,6 +3423,14 @@ empathy_chat_class_init (EmpathyChatClass *klass)
 			      G_TYPE_NONE,
 			      1, G_TYPE_BOOLEAN);
 
+	/**
+	 * EmpathyChat::new-message:
+	 * @self: the #EmpathyChat
+	 * @message: the new message
+	 * @pending: whether the message was in the pending queue when @self
+	 *  was created
+	 * @should_highlight: %TRUE if the message mentions the local user
+	 */
 	signals[NEW_MESSAGE] =
 		g_signal_new ("new-message",
 			      G_OBJECT_CLASS_TYPE (object_class),
@@ -3308,7 +3439,7 @@ empathy_chat_class_init (EmpathyChatClass *klass)
 			      NULL, NULL,
 			      g_cclosure_marshal_generic,
 			      G_TYPE_NONE,
-			      2, EMPATHY_TYPE_MESSAGE, G_TYPE_BOOLEAN);
+			      3, EMPATHY_TYPE_MESSAGE, G_TYPE_BOOLEAN, G_TYPE_BOOLEAN);
 
 	signals[PART_COMMAND_ENTERED] =
 			g_signal_new ("part-command-entered",
@@ -3874,6 +4005,9 @@ empathy_chat_set_tp_chat (EmpathyChat   *chat,
 	g_signal_connect (tp_chat, "member-renamed",
 			  G_CALLBACK (chat_member_renamed_cb),
 			  chat);
+	g_signal_connect_swapped (tp_chat, "notify::self-contact",
+				  G_CALLBACK (chat_self_contact_changed_cb),
+				  chat);
 	g_signal_connect_swapped (tp_chat, "notify::remote-contact",
 				  G_CALLBACK (chat_remote_contact_changed_cb),
 				  chat);
@@ -3895,6 +4029,7 @@ empathy_chat_set_tp_chat (EmpathyChat   *chat,
 
 	/* Get initial value of properties */
 	chat_sms_channel_changed_cb (chat);
+	chat_self_contact_changed_cb (chat);
 	chat_remote_contact_changed_cb (chat);
 	chat_title_changed_cb (chat);
 	chat_subject_changed_cb (chat);
diff --git a/libempathy-gtk/empathy-theme-adium.c b/libempathy-gtk/empathy-theme-adium.c
index 7b0cd2169..98df46b79 100644
--- a/libempathy-gtk/empathy-theme-adium.c
+++ b/libempathy-gtk/empathy-theme-adium.c
@@ -132,13 +132,15 @@ typedef struct {
 	guint type;
 	EmpathyMessage *msg;
 	char *str;
+	gboolean should_highlight;
 } QueuedItem;
 
 static QueuedItem *
 queue_item (GQueue *queue,
 	    guint type,
 	    EmpathyMessage *msg,
-	    const char *str)
+	    const char *str,
+	    gboolean should_highlight)
 {
 	QueuedItem *item = g_slice_new0 (QueuedItem);
 
@@ -146,6 +148,7 @@ queue_item (GQueue *queue,
 	if (msg != NULL)
 		item->msg = g_object_ref (msg);
 	item->str = g_strdup (str);
+	item->should_highlight = should_highlight;
 
 	g_queue_push_tail (queue, item);
 
@@ -775,7 +778,8 @@ theme_adium_remove_all_focus_marks (EmpathyThemeAdium *theme)
 
 static void
 theme_adium_append_message (EmpathyChatView *view,
-			    EmpathyMessage  *msg)
+			    EmpathyMessage  *msg,
+			    gboolean         should_highlight)
 {
 	EmpathyThemeAdium     *theme = EMPATHY_THEME_ADIUM (view);
 	EmpathyThemeAdiumPriv *priv = GET_PRIV (theme);
@@ -797,7 +801,7 @@ theme_adium_append_message (EmpathyChatView *view,
 	gboolean               action;
 
 	if (priv->pages_loading != 0) {
-		queue_item (&priv->message_queue, QUEUED_MESSAGE, msg, NULL);
+		queue_item (&priv->message_queue, QUEUED_MESSAGE, msg, NULL, should_highlight);
 		return;
 	}
 
@@ -886,7 +890,7 @@ theme_adium_append_message (EmpathyChatView *view,
 	} else {
 		g_string_append (message_classes, " incoming");
 	}
-	if (empathy_message_should_highlight (msg)) {
+	if (should_highlight) {
 		g_string_append (message_classes, " mention");
 	}
 	if (empathy_message_get_tptype (msg) == TP_CHANNEL_TEXT_MESSAGE_TYPE_AUTO_REPLY) {
@@ -975,7 +979,7 @@ theme_adium_append_event (EmpathyChatView *view,
 	gchar *str_escaped;
 
 	if (priv->pages_loading != 0) {
-		queue_item (&priv->message_queue, QUEUED_EVENT, NULL, str);
+		queue_item (&priv->message_queue, QUEUED_EVENT, NULL, str, FALSE);
 		return;
 	}
 
@@ -1005,7 +1009,7 @@ theme_adium_edit_message (EmpathyChatView *view,
 	GError *error = NULL;
 
 	if (priv->pages_loading != 0) {
-		queue_item (&priv->message_queue, QUEUED_EDIT, message, NULL);
+		queue_item (&priv->message_queue, QUEUED_EDIT, message, NULL, FALSE);
 		return;
 	}
 
@@ -1345,7 +1349,8 @@ theme_adium_load_finished_cb (WebKitWebView  *view,
 		switch (item->type)
 		{
 			case QUEUED_MESSAGE:
-				theme_adium_append_message (chat_view, item->msg);
+				theme_adium_append_message (chat_view, item->msg,
+					item->should_highlight);
 				break;
 
 			case QUEUED_EDIT:
diff --git a/libempathy-gtk/empathy-theme-boxes.c b/libempathy-gtk/empathy-theme-boxes.c
index b9fd08d84..cf0c65268 100644
--- a/libempathy-gtk/empathy-theme-boxes.c
+++ b/libempathy-gtk/empathy-theme-boxes.c
@@ -337,7 +337,8 @@ theme_boxes_maybe_append_header (EmpathyThemeBoxes *theme,
 
 static void
 theme_boxes_append_message (EmpathyChatTextView *view,
-			    EmpathyMessage      *message)
+			    EmpathyMessage      *message,
+			    gboolean             should_highlight)
 {
 	EmpathyContact *sender;
 
diff --git a/libempathy-gtk/empathy-theme-irc.c b/libempathy-gtk/empathy-theme-irc.c
index 2ee81a23e..ed8e3b380 100644
--- a/libempathy-gtk/empathy-theme-irc.c
+++ b/libempathy-gtk/empathy-theme-irc.c
@@ -50,7 +50,8 @@ theme_irc_create_tags (EmpathyThemeIrc *theme)
 
 static void
 theme_irc_append_message (EmpathyChatTextView *view,
-			  EmpathyMessage      *message)
+			  EmpathyMessage      *message,
+			  gboolean             should_highlight)
 {
 	GtkTextBuffer *buffer;
 	const gchar   *name;
@@ -77,7 +78,7 @@ theme_irc_append_message (EmpathyChatTextView *view,
 	if (empathy_contact_is_user (contact)) {
 		nick_tag = EMPATHY_THEME_IRC_TAG_NICK_SELF;
 	} else {
-		if (empathy_message_should_highlight (message)) {
+		if (should_highlight) {
 			nick_tag = EMPATHY_THEME_IRC_TAG_NICK_HIGHLIGHT;
 		} else {
 			nick_tag = EMPATHY_THEME_IRC_TAG_NICK_OTHER;