[NEW] Send LiveChat visitor navigation history as messages

.eslintrc

@@ -119,6 +119,7 @@
 		"LivechatDepartmentAgents"    : false,
 		"livechatManagerRoutes"       : true,
 		"LivechatPageVisited"         : false,
+		"LivechatMessage"             : false,
 		"LivechatTrigger"             : false,
 		"Logger"                      : false,
 		"Match"                       : false,

packages/rocketchat-i18n/i18n/en.i18n.json

@@ -827,6 +827,7 @@
   "False": "False",
   "Favorite_Rooms": "Enable Favorite Rooms",
   "Favorites": "Favorites",
+  "Feature_Depends_on_Livechat_Visitor_navigation_as_a_message_to_be_enabled": "This feature depends on \"Send Visitor Navigation History as a Message\" to be enabled.",
   "Features_Enabled": "Features Enabled",
   "Field": "Field",
   "Field_removed": "Field removed",
@@ -1463,6 +1464,8 @@
   "Mobile_Notifications_Default_Alert": "Mobile Notifications Default Alert",
   "Monday": "Monday",
   "Monitor_history_for_changes_on": "Monitor History for Changes on",
+  "Send_Visitor_navigation_history_as_a_message": "Send Visitor Navigation History as a Message",
+  "Send_visitor_navigation_history_on_request": "Send Visitor Navigation History on Request",
   "More_channels": "More channels",
   "More_direct_messages": "More direct messages",
   "More_groups": "More private groups",
@@ -1505,6 +1508,7 @@
   "New_Trigger": "New Trigger",
   "New_version_available_(s)": "New version available (%s)",
   "New_videocall_request": "New Video Call Request",
+  "New_visitor_navigation": "New Visitor Navigation",
   "No_available_agents_to_transfer": "No available agents to transfer",
   "No_channel_with_name_%s_was_found": "No channel with name <strong>\"%s\"</strong> was found!",
   "No_channels_yet": "You aren't part of any channel yet",

packages/rocketchat-i18n/i18n/pt-BR.i18n.json

@@ -794,6 +794,7 @@
   "False": "Não",
   "Favorite_Rooms": "Ativar salas favoritas",
   "Favorites": "Favoritos",
+  "Feature_Depends_on_Livechat_Visitor_navigation_as_a_message_to_be_enabled": "Esta Funcionalidade depende que \"Enviar histórico de navegação do visitante como mensagem\" esteja habilitada.",
   "Features_Enabled": "Funcionalidades habilitadas",
   "Field": "Campo",
   "Field_removed": "Campo removido",
@@ -1458,6 +1459,7 @@
   "New_Trigger": "Novo Gatilho",
   "New_version_available_(s)": "Nova versão disponível (% s)",
   "New_videocall_request": "Nova requisição de chamada de vídeo",
+  "New_visitor_navigation": "Nova Navegação do visitante",
   "No_available_agents_to_transfer": "Nenhum agente disponível para transferir",
   "No_channel_with_name_%s_was_found": "Nenhum canal com nome <strong>\"%s\"</strong> foi encontrado!",
   "No_channels_yet": "Você não faz parte de nenhum canal ainda.",
@@ -1818,6 +1820,8 @@
   "Send_request_on_visitor_message": "Enviar requisição para mensagens do Visitante",
   "Send_request_on_agent_message": "Enviar requisição para mensagens do Agente",
   "Send_Test": "Enviar teste",
+  "Send_Visitor_navigation_history_as_a_message": "Enviar histórico de navegação do visitante como mensagem",
+  "Send_visitor_navigation_history_on_request": "Enviar histórico de navegação do visitante na requisição",
   "Send_welcome_email": "Enviar e-mail de boas-vindas",
   "Send_your_JSON_payloads_to_this_URL": "Envie seu payload  JSON para esta URL.",
   "Sending": "Enviando ...",

packages/rocketchat-lib/server/models/Messages.js

@@ -299,6 +299,17 @@ RocketChat.models.Messages = new class extends RocketChat.models._Base {
 		return this.findOne(query);
 	}
 
+	findByRoomIdAndType(roomId, type, options) {
+		const query = {
+			rid: roomId,
+			t: type
+		};
+
+		if (options == null) { options = {}; }
+
+		return this.find(query, options);
+	}
+
 	findByRoomId(roomId, options) {
 		const query = {
 			rid: roomId
@@ -569,6 +580,34 @@ RocketChat.models.Messages = new class extends RocketChat.models._Base {
 		return record;
 	}
 
+	createNavigationHistoryWithRoomIdMessageAndUser(roomId, message, user, extraData) {
+		const type = 'livechat_navigation_history';
+		const room = RocketChat.models.Rooms.findOneById(roomId, { fields: { sysMes: 1 }});
+		if ((room != null ? room.sysMes : undefined) === false) {
+			return;
+		}
+		const record = {
+			t: type,
+			rid: roomId,
+			ts: new Date,
+			msg: message,
+			u: {
+				_id: user._id,
+				username: user.username
+			},
+			groupable: false
+		};
+
+		if (RocketChat.settings.get('Message_Read_Receipt_Enabled')) {
+			record.unread = true;
+		}
+
+		_.extend(record, extraData);
+
+		record._id = this.insertOrUpsert(record);
+		return record;
+	}
+
 	createUserJoinWithRoomIdAndUser(roomId, user, extraData) {
 		const message = user.username;
 		return this.createWithTypeRoomIdMessageAndUser('uj', roomId, message, user, extraData);

packages/rocketchat-livechat/.app/client/lib/hooks.js

@@ -7,7 +7,7 @@ const api = {
 			Triggers.processRequest(info);
 		}
 
-		Meteor.call('livechat:pageVisited', visitor.getToken(), info);
+		Meteor.call('livechat:pageVisited', visitor.getToken(), visitor.getRoom(), info);
 	},
 
 	setCustomField(key, value, overwrite = true) {

packages/rocketchat-livechat/.app/client/views/messages.js

@@ -7,7 +7,7 @@ Template.messages.helpers({
 		return ChatMessage.find({
 			rid: visitor.getRoom(),
 			t: {
-				'$ne': 't'
+				'$nin': ['t', 'livechat_navigation_history']
 			}
 		}, {
 			sort: {

packages/rocketchat-livechat/.app/imports/client/visitor.js

@@ -63,10 +63,11 @@ export default {
 
 		this.roomSubscribed = roomId;
 
+		const msgTypesNotDisplayed = ['livechat_video_call', 'livechat_navigation_history', 'au'];
 		msgStream.on(roomId, { token: this.getToken() }, (msg) => {
 			if (msg.t === 'command') {
 				Commands[msg.msg] && Commands[msg.msg]();
-			} else if ((msg.t !== 'livechat_video_call') && (msg.t !== 'au')) {
+			} else if (!msgTypesNotDisplayed.includes(msg.t)) {
 				ChatMessage.upsert({ _id: msg._id }, msg);
 
 				if (msg.t === 'livechat-close') {

packages/rocketchat-livechat/client/collections/LivechatMessage.js

@@ -0,0 +1 @@
+this.LivechatMessage = new Mongo.Collection('rocketchat_message');

packages/rocketchat-livechat/client/views/app/tabbar/visitorNavigation.html

@@ -8,8 +8,8 @@ <h4>{{_ "Navigation_History"}}</h4>
 				{{else}}
 					<div class="visitor-scroll">
 						<ul>
-							{{#each pageVisited}}
-								<li><a href="{{page.location.href}}" target="_blank" title="{{accessDateTime}}">{{pageTitle}}</a></li>
+							{{#each pages}}
+								<li><a href="{{navigation.page.location.href}}" target="_blank" title="{{accessDateTime}}">{{pageTitle}}</a></li>
 							{{/each}}
 						</ul>
 					</div>

packages/rocketchat-livechat/client/views/app/tabbar/visitorNavigation.js

@@ -1,20 +1,21 @@
 import moment from 'moment';
+const visitorNavigationHistory = new Mongo.Collection('visitor_navigation_history');
 
 Template.visitorNavigation.helpers({
 	loadingNavigation() {
 		return !Template.instance().pageVisited.ready();
 	},
 
-	pageVisited() {
+	pages() {
 		const room = ChatRoom.findOne({ _id: this.rid }, { fields: { 'v.token': 1 } });
 
-		if (room && room.v && room.v.token) {
-			return LivechatPageVisited.find({ token: room.v.token }, { sort: { ts: -1 } });
+		if (room) {
+			return visitorNavigationHistory.find({ rid: room._id }, { sort: { ts: -1 } });
 		}
 	},
 
 	pageTitle() {
-		return this.page.title || t('Empty_title');
+		return this.navigation.page.title || t('Empty_title');
 	},
 
 	accessDateTime() {

packages/rocketchat-livechat/config.js

@@ -181,6 +181,15 @@ Meteor.startup(function() {
 		i18nLabel: 'Send_request_on_agent_message'
 	});
 
+	RocketChat.settings.add('Send_visitor_navigation_history_livechat_webhook_request', false, {
+		type: 'boolean',
+		group: 'Livechat',
+		section: 'CRM_Integration',
+		i18nLabel: 'Send_visitor_navigation_history_on_request',
+		i18nDescription: 'Feature_Depends_on_Livechat_Visitor_navigation_as_a_message_to_be_enabled',
+		enableQuery: { _id: 'Livechat_Visitor_navigation_as_a_message', value: true }
+	});
+
 	RocketChat.settings.add('Livechat_webhook_on_capture', false, {
 		type: 'boolean',
 		group: 'Livechat',
@@ -236,6 +245,13 @@ Meteor.startup(function() {
 		]
 	});
 
+	RocketChat.settings.add('Livechat_Visitor_navigation_as_a_message', false, {
+		type: 'boolean',
+		group: 'Livechat',
+		public: true,
+		i18nLabel: 'Send_Visitor_navigation_history_as_a_message'
+	});
+
 	RocketChat.settings.add('Livechat_enable_office_hours', false, {
 		type: 'boolean',
 		group: 'Livechat',

packages/rocketchat-livechat/messageTypes.js

@@ -1,3 +1,8 @@
+RocketChat.MessageTypes.registerType({
+	id: 'livechat_navigation_history',
+	system: true
+});
+
 RocketChat.MessageTypes.registerType({
 	id: 'livechat_video_call',
 	system: true,

packages/rocketchat-livechat/package.js

@@ -183,6 +183,7 @@ Package.onUse(function(api) {
 	// models
 	api.addFiles('server/models/Users.js', 'server');
 	api.addFiles('server/models/Rooms.js', 'server');
+	api.addFiles('server/models/Messages.js', 'server');
 	api.addFiles('server/models/LivechatExternalMessage.js', ['client', 'server']);
 	api.addFiles('server/models/LivechatCustomField.js', 'server');
 	api.addFiles('server/models/LivechatDepartment.js', 'server');

packages/rocketchat-livechat/server/hooks/sendToCRM.js

@@ -1,3 +1,11 @@
+const msgNavType = 'livechat_navigation_history';
+
+const sendMessageType = (msgType) => {
+	const sendNavHistory = RocketChat.settings.get('Livechat_Visitor_navigation_as_a_message') && RocketChat.settings.get('Send_visitor_navigation_history_livechat_webhook_request');
+
+	return sendNavHistory && msgType === msgNavType;
+};
+
 function sendToCRM(type, room, includeMessages = true) {
 	const postData = RocketChat.Livechat.getLivechatRoomGuestInfo(room);
 
@@ -14,7 +22,7 @@ function sendToCRM(type, room, includeMessages = true) {
 
 	if (messages) {
 		messages.forEach((message) => {
-			if (message.t) {
+			if (message.t && !sendMessageType(message.t)) {
 				return;
 			}
 			const msg = {
@@ -28,6 +36,11 @@ function sendToCRM(type, room, includeMessages = true) {
 			if (message.u.username !== postData.visitor.username) {
 				msg.agentId = message.u._id;
 			}
+
+			if (message.t === msgNavType) {
+				msg.navigation = message.navigation;
+			}
+
 			postData.messages.push(msg);
 		});
 	}
@@ -73,9 +86,9 @@ RocketChat.callbacks.add('afterSaveMessage', function(message, room) {
 	} else if (!RocketChat.settings.get('Livechat_webhook_on_agent_message')) {
 		return message;
 	}
-
 	// if the message has a type means it is a special message (like the closing comment), so skips
-	if (message.t) {
+	// unless the settings that handle with visitor navigation history are enabled
+	if (message.t && !sendMessageType(message.t)) {
 		return message;
 	}
 

packages/rocketchat-livechat/server/lib/Livechat.js

@@ -105,6 +105,10 @@ RocketChat.Livechat = {
 			throw new Meteor.Error('cannot-access-room');
 		}
 
+		if (newRoom) {
+			RocketChat.models.Messages.setRoomIdByToken(guest.token, room._id);
+		}
+
 		return { room, newRoom };
 	},
 	sendMessage({ guest, message, roomInfo, agent }) {
@@ -315,9 +319,31 @@ RocketChat.Livechat = {
 		});
 	},
 
-	savePageHistory(token, pageInfo) {
+	savePageHistory(token, roomId, pageInfo) {
 		if (pageInfo.change === RocketChat.Livechat.historyMonitorType) {
-			return RocketChat.models.LivechatPageVisited.saveByToken(token, pageInfo);
+
+			const user = RocketChat.models.Users.findOneById('rocket.cat');
+
+			const pageTitle = pageInfo.title;
+			const pageUrl = pageInfo.location.href;
+			const extraData = {
+				navigation: {
+					page: pageInfo,
+					token
+				}
+			};
+
+			if (!roomId) {
+				// keep history of unregistered visitors for 1 month
+				const keepHistoryMiliseconds = 2592000000;
+				extraData.expireAt = new Date().getTime() + keepHistoryMiliseconds;
+			}
+
+			if (!RocketChat.settings.get('Livechat_Visitor_navigation_as_a_message')) {
+				extraData._hidden = true;
+			}
+
+			return RocketChat.models.Messages.createNavigationHistoryWithRoomIdMessageAndUser(roomId, `${ TAPi18n.__('New_visitor_navigation') }: ${ pageTitle } - ${ pageUrl }`, user, extraData);
 		}
 
 		return;

packages/rocketchat-livechat/server/methods/pageVisited.js

@@ -1,5 +1,5 @@
 Meteor.methods({
-	'livechat:pageVisited'(token, pageInfo) {
-		return RocketChat.Livechat.savePageHistory(token, pageInfo);
+	'livechat:pageVisited'(token, room, pageInfo) {
+		RocketChat.Livechat.savePageHistory(token, room, pageInfo);
 	}
 });

packages/rocketchat-livechat/server/methods/registerGuest.js

@@ -8,7 +8,7 @@ Meteor.methods({
 		});
 
 		// update visited page history to not expire
-		RocketChat.models.LivechatPageVisited.keepHistoryForToken(token);
+		RocketChat.models.Messages.keepHistoryForToken(token);
 
 		return {
 			userId

packages/rocketchat-livechat/server/methods/sendTranscript.js

@@ -19,7 +19,7 @@ Meteor.methods({
 			throw new Meteor.Error('error-invalid-room', 'Invalid room');
 		}
 
-		const messages = RocketChat.models.Messages.findVisibleByRoomId(rid, { sort: { 'ts' : 1 }});
+		const messages = RocketChat.models.Messages.findVisibleByRoomIdNotContainingTypes(rid, ['livechat_navigation_history'], { sort: { 'ts' : 1 }});
 		const header = RocketChat.placeholders.replace(RocketChat.settings.get('Email_Header') || '');
 		const footer = RocketChat.placeholders.replace(RocketChat.settings.get('Email_Footer') || '');
 

packages/rocketchat-livechat/server/methods/setDepartmentForVisitor.js

@@ -6,7 +6,7 @@ Meteor.methods({
 		});
 
 		// update visited page history to not expire
-		RocketChat.models.LivechatPageVisited.keepHistoryForToken(token);
+		RocketChat.models.Messages.keepHistoryForToken(token);
 
 		return true;
 	}

packages/rocketchat-livechat/server/models/Messages.js

@@ -0,0 +1,27 @@
+RocketChat.models.Messages.keepHistoryForToken = function(token) {
+	return this.update({
+		'navigation.token': token,
+		expireAt: {
+			$exists: true
+		}
+	}, {
+		$unset: {
+			expireAt: 1
+		}
+	}, {
+		multi: true
+	});
+};
+
+RocketChat.models.Messages.setRoomIdByToken = function(token, rid) {
+	return this.update({
+		'navigation.token': token,
+		rid: null
+	}, {
+		$set: {
+			rid
+		}
+	}, {
+		multi: true
+	});
+};