@tiledesk/tiledesk-server 2.2.38 → 2.3.1-8.1

package/README.md

@@ -9,11 +9,23 @@
 
 # Introduction
 
-Tiledesk-server is the server engine of Tiledesk. Tiledesk is an Open Source Live Chat platform with integrated ChatBot written in NodeJs and Express. Build your own customer support with a multi-channel platform for Web, Android and iOS. More info here https://www.tiledesk.com.
+Tiledesk-server is the server engine of Tiledesk. Tiledesk is an Open Source Live Chat platform with integrated Chatbots written in NodeJs and Express. Build your own customer support with a multi-channel platform for Web, Android and iOS. 
 
-You can find more info here: https://developer.tiledesk.com
+Designed to be open source since the beginning, we actively worked on it to create a totally new, first class customer service platform based on instant messaging.
 
-# Prerequisites
+What is Tiledesk today? It became the open source “conversational app development” platform that everyone needs 😌
+
+You can use Tiledesk to increase sales for your website or for post-sales customer service. Every conversation can be automated using our first class native chatbot technology.
+You can also connect your own applications using our APIs or Webhooks.
+Moreover you can deploy entire visual applications inside a conversation. And your applications can converse with your chatbots or your end-users! We know this is cool 😎
+
+Tiledesk is multichannel in a totally new way. You can write your chatbot scripts with images, buttons and other cool elements that your channels support. But you will configureyour chatbot replies only once. They will run on every channel, auto-adapting the responses to the target channel whatever it is, Whatsapp, Facebook Messenger, Telegram etc.
+
+More info on Tiledesk website: https://www.tiledesk.com.
+
+You can find technical documentation here: https://developer.tiledesk.com
+
+# Prerequisites for Installation
 
 * [Nodejs](https://www.npmjs.com/) and npm installed. Suggested versions are NodeJS 12.20.2 and NPM 6.14.11 
 * [MongoDb](https://www.mongodb.com) installed
@@ -25,23 +37,6 @@ Use [Docker Compose Tiledesk installation guide](https://github.com/Tiledesk/til
 
 # Running Tiledesk Server
 
-## Run locally with npm
-
-Steps to run with npm:
-
-```
-npm install -g @tiledesk/tiledesk-server mongodb-runner
-mongodb-runner start
-curl https://raw.githubusercontent.com/Tiledesk/tiledesk-server/master/.env.sample --output .env
-nano .env #configure .env file properly
-tiledesk-server  
-```
-
-If you want to load .env file from another path: `DOTENV_PATH=/MY/ABSOLUTE/PATH/.env tiledesk-server`
-
-Note: If installation with -g fails due to permission problems (npm ERR! code 'EACCES'), please refer to this [link](https://docs.npmjs.com/getting-started/fixing-npm-permissions).
-
-
 ## Using Docker
 
 
@@ -65,12 +60,30 @@ Otherwise if you want to run tiledesk only with docker run :
 docker run -p 3000:3000 --env DATABASE_URI="mongodb://YOUR_MONGO_INSTALLATION_ENDPOINT/tiledesk-server" --env-file .env tiledesk/tiledesk-server
 ```
 
+
+
+## Run locally with npm
+
+Steps to run with npm:
+
+```
+npm install -g @tiledesk/tiledesk-server mongodb-runner
+mongodb-runner start
+curl https://raw.githubusercontent.com/Tiledesk/tiledesk-server/master/.env.sample --output .env
+nano .env #configure .env file properly
+tiledesk-server  
+```
+
+If you want to load .env file from another path: `DOTENV_PATH=/MY/ABSOLUTE/PATH/.env tiledesk-server`
+
+Note: If installation with -g fails due to permission problems (npm ERR! code 'EACCES'), please refer to this [link](https://docs.npmjs.com/getting-started/fixing-npm-permissions).
+
 ## Install from source code
 
 * Clone this repo
 * Install dependencies with `npm install`
 * Configure the tiledesk .env file. You can see an example in the file .env.sample under the root folder. Rename it from .env.sample to .env and configure it properly. 
-* Run the app with the command `npm start` or with `nodemon` if you want monitoring and auto reload. Install nodemon with `npm install -g nodemon`
+* Run the app with the command `npm start`.
 
 
 ## Deploy on Heroku
@@ -79,6 +92,8 @@ Deploy with button:
 
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/Tiledesk/tiledesk-server)
 
+# Community? Questions? Support ?
+If you need help or just want to hang out, come, say hi on our [<img width="15" alt="Tiledesk discord" src="https://seeklogo.com/images/D/discord-color-logo-E5E6DFEF80-seeklogo.com.png"> Discord](https://discord.gg/nERZEZ7SmG) server.
 
 # REST API
 

package/app.js

@@ -30,6 +30,7 @@ var Project = require("./models/project");
 var validtoken = require('./middleware/valid-token');
 var roleChecker = require('./middleware/has-role');
 
+const MaskData = require("maskdata");
 var winston = require('./config/winston');
 
 // https://bretkikehara.wordpress.com/2013/05/02/nodejs-creating-your-first-global-module/
@@ -43,7 +44,18 @@ if (process.env.NODE_ENV == 'test')  {
   databaseUri = config.databasetest;
 }
 
-winston.info("DatabaseUri: " + databaseUri);
+const masked_databaseUri = MaskData.maskPhone(databaseUri, {
+        maskWith : "*",
+        unmaskedStartDigits: 15, 
+        unmaskedEndDigits: 5
+      });
+
+if (process.env.DISABLE_MONGO_PASSWORD_MASK ==true || process.env.DISABLE_MONGO_PASSWORD_MASK == "true")  {
+  winston.info("DatabaseUri: " + databaseUri);
+}else {
+  winston.info("DatabaseUri: " + masked_databaseUri);
+}
+
 
 var autoIndex = true;
 if (process.env.MONGOOSE_AUTOINDEX) {
@@ -75,6 +87,9 @@ var lead = require('./routes/lead');
 var message = require('./routes/message');
 var messagesRootRoute = require('./routes/messagesRoot');
 var department = require('./routes/department');
+var group = require('./routes/group');
+var resthook = require('./routes/subscription');
+var tag = require('./routes/tag');
 var faq = require('./routes/faq');
 var faq_kb = require('./routes/faq_kb');
 var project = require('./routes/project');
@@ -112,6 +127,9 @@ var RouterLogger = require('./models/routerLogger');
 
 require('./services/mongoose-cache-fn')(mongoose);
 
+var subscriptionNotifier = require('./services/subscriptionNotifier');
+subscriptionNotifier.start();
+
 var botSubscriptionNotifier = require('./services/BotSubscriptionNotifier');
 botSubscriptionNotifier.start();
  
@@ -123,15 +141,15 @@ var faqBotHandler = require('./services/faqBotHandler');
 faqBotHandler.listen();
 
 var pubModulesManager = require('./pubmodules/pubModulesManager');
-  pubModulesManager.init();
-
+pubModulesManager.init({express:express, mongoose:mongoose, passport:passport, databaseUri:databaseUri, routes:{}});
   
 var channelManager = require('./channels/channelManager');
 channelManager.listen(); 
 
-const ipfilter = require('express-ipfilter').IpFilter
-// const IpDeniedError = require('express-ipfilter').IpDeniedError;
+var IPFilter = require('./middleware/ipFilter');
 
+var BanUserNotifier = require('./services/banUserNotifier');
+BanUserNotifier.listen();
 
 var modulesManager = undefined;
 try {
@@ -158,7 +176,6 @@ if (process.env.CREATE_INITIAL_DATA !== "false") {
 
 
 
-
 var app = express();
 
 
@@ -319,57 +336,6 @@ var projectSetter = function (req, res, next) {
 }
 
 
-function customDetection (req)  {
-  // const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;  
-  const ip = (req.headers['x-forwarded-for'] || '').split(',').pop().trim() ||        //https://stackoverflow.com/questions/8107856/how-to-determine-a-users-ip-address-in-node
-    req.socket.remoteAddress
-
-  winston.info("standard ip: "+ip); // ip address of the user
-  return ip;
-}
-
-
-var projectIpFilter = function (req, res, next) {
-  // var projectIpFilter = function (err, req, res, next) {
-
-    // var ip = require('ip');
-    // winston.info("projectIpFilter ip2: " + ip.address() );
-
-
-    const nextIp = function(err) {
-      winston.info("projectIpFilter next",err);
-
-        if (err && err.name === "IpDeniedError") {
-          winston.info("IpDeniedError");
-          return res.status(401).json({ err: "error project ip filter" });
-          // next(err) 
-        } 
-
-      next();
-
-  }
-
-
-  if (!req.project) {
-    return next();
-  }
-  
-  var projectIpFilterEnabled = req.project.ipFilterEnabled;
-  winston.debug("project projectIpFilterEnabled: " +projectIpFilterEnabled)
-
-  var projectIpFilter =  req.project.ipFilter
-  winston.debug("project ipFilter: " + projectIpFilter)
-  
-  if (projectIpFilterEnabled === true && projectIpFilter && projectIpFilter.length > 0) {
-    var ip = ipfilter(projectIpFilter, { detectIp: customDetection, mode: 'allow' })
-    // var ip = ipfilter(projectIpFilter, { mode: 'allow' })
-    ip(req, res, nextIp);
-  } else {
-    next();
-  }
-
-}
-
 
 
 // app.use('/admin', admin);
@@ -386,6 +352,8 @@ app.use('/auth', auth);
 app.use('/testauth', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken], authtest);
 
 app.use('/widgets', widgetsLoader);
+app.use('/w', widgetsLoader);
+
 app.use('/images', images);
 app.use('/files', files);
 app.use('/urls', urls);
@@ -413,8 +381,7 @@ if (modulesManager) {
   modulesManager.use(app);
 }
 
-
-app.use('/:projectid/', [projectIdSetter, projectSetter, projectIpFilter]);
+app.use('/:projectid/', [projectIdSetter, projectSetter, IPFilter.projectIpFilter, IPFilter.projectIpFilterDeny, IPFilter.decodeJwt, IPFilter.projectBanUserFilter]);
 
 
 app.use('/:projectid/authtestWithRoleCheck', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken], authtestWithRoleCheck);
@@ -429,11 +396,17 @@ app.use('/:projectid/departments', department);
 
 
 
+
+
 channelManager.useUnderProjects(app);
 
+app.use('/:projectid/groups', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], group);
+app.use('/:projectid/tags', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], tag);
+app.use('/:projectid/subscriptions', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('admin')], resthook);
+
 //deprecated
-app.use('/:projectid/faq', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], faq);
-app.use('/:projectid/intents', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], faq);
+app.use('/:projectid/faq', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], faq);
+app.use('/:projectid/intents', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], faq);
 
 //Deprecated??
 app.use('/:projectid/faqpub', faqpub);
@@ -516,7 +489,7 @@ app.use(function (err, req, res, next) {
 // error handler
 app.use((err, req, res, next) => {
 
-  winston.info("err.name", err.name)
+  winston.debug("err.name", err.name)
   if (err.name === "IpDeniedError") {
     winston.info("IpDeniedError");
     return res.status(401).json({ err: "error ip filter" });

package/channels/chat21/chat21Handler.js

@@ -246,7 +246,18 @@ class Chat21Handler {
         });
 
 
+        messageEvent.on('message.test', function(message) {
+        
+            winston.info("Chat21Sender message.test");
+
+            chat21.auth.setAdminToken(adminToken);
 
+            return  chat21.messages.sendToGroup(message.senderFullname,     message.recipient, 
+                message.recipient_fullname, message.text, message.sender, message.attributes, message.type, message.metadata, message.timestamp, message.group)
+                        .then(function(data){
+                            winston.info("Chat21Sender sendToGroup test: "+ JSON.stringify(data));
+                        });
+        });
        
 
         messageEvent.on('message.sending', function(message) {
@@ -299,7 +310,8 @@ class Chat21Handler {
                             }
 
                             var recipient_fullname = "Guest"; 
-                            // TODO qui va message.recipient_fullname ma nn c'è
+                            // guest_here
+                        
                             if (message.request && message.request.lead && message.request.lead.fullname) {
                                 recipient_fullname = message.request.lead.fullname;
                             }
@@ -332,6 +344,7 @@ class Chat21Handler {
                             }    
                             */   
                          
+
                            return  chat21.messages.sendToGroup(message.senderFullname,     message.recipient, 
                                 recipient_fullname, message.text, message.sender, attributes, message.type, message.metadata, timestamp)
                                         .then(function(data){
@@ -339,7 +352,7 @@ class Chat21Handler {
                                     
 
                                             // chat21.conversations.stopTyping(message.recipient,message.sender);
-    
+
                                             chat21Event.emit('message.sent', data);
     
                                                 messageService.changeStatus(message._id, MessageConstants.CHAT_MESSAGE_STATUS.DELIVERED) .then(function(upMessage){
@@ -563,13 +576,15 @@ class Chat21Handler {
                         var groupId = request.request_id;
 
                         var group_name = "Guest"; 
-
+                        // guest_here
+                        
                         if (request.lead && request.lead.fullname) {
                             group_name = request.lead.fullname;
                         }
                         if (request.subject) {
                             group_name = request.subject;
                         }
+
                         //TODO racecondition?
                         return chat21.groups.create(group_name, members, gAttributes, groupId).then(function(data) {
                                 winston.verbose("Chat21 group created: " + JSON.stringify(data));      

package/channels/chat21/chat21WebHook.js

@@ -201,12 +201,16 @@ router.post('/', function (req, res) {
                         return winston.error("project_user not found with query: ", queryProjectUser);                        
                       }
 
+
+                    
+
                       
                       var new_request = {
                         request_id: message.recipient, project_user_id:project_user_id, lead_id:createdLead._id, id_project:projectid, first_text:message.text,
                         departmentid:departmentid, sourcePage:sourcePage, language:language, userAgent:client, status:requestStatus, createdBy: undefined,
                         attributes:rAttributes, subject:undefined, preflight:false, channel:undefined, location:undefined,
                         lead:createdLead, requester:project_user
+                        
                       };
     
                       winston.debug("new_request", new_request);
@@ -226,10 +230,10 @@ router.post('/', function (req, res) {
                        // upsert(id, sender, senderFullname, recipient, text, id_project, createdBy, status, attributes, type, metadata, language)
                         return messageService.upsert(messageId, message.sender, message.sender_fullname, message.recipient, message.text,
                           projectid, null, MessageConstants.CHAT_MESSAGE_STATUS.RECEIVED, message.attributes, message.type, message.metadata, language).then(function(savedMessage){
-                                                                
-                            return requestService.incrementMessagesCountByRequestId(savedRequest.request_id, savedRequest.id_project).then(function(savedRequestWithIncrement) {
-                              return res.json(savedRequestWithIncrement);
-                            });
+                            return res.json(savedRequest);                                  
+                            // return requestService.incrementMessagesCountByRequestId(savedRequest.request_id, savedRequest.id_project).then(function(savedRequestWithIncrement) {
+                              // return res.json(savedRequestWithIncrement);
+                            // });
                           
                         
                       }).catch(function (err) {
@@ -286,23 +290,25 @@ router.post('/', function (req, res) {
 
                 // TOOD update also request attributes and sourcePage
                 
-                    return requestService.incrementMessagesCountByRequestId(request.request_id, request.id_project).then(function(savedRequest) {
+                    // return requestService.incrementMessagesCountByRequestId(request.request_id, request.id_project).then(function(savedRequest) {
                       // winston.debug("savedRequest.participants.indexOf(message.sender)", savedRequest.participants.indexOf(message.sender));
                        
                       // TODO it doesn't work for internal requests bacause participanets == message.sender⁄
-                      if (savedRequest.participants && savedRequest.participants.indexOf(message.sender) > -1) { //update waiitng time if write an  agent (member of participants)
+                      if (request.participants && request.participants.indexOf(message.sender) > -1) { //update waiitng time if write an  agent (member of participants)
                         winston.debug("updateWaitingTimeByRequestId");
+                        
                         return requestService.updateWaitingTimeByRequestId(request.request_id, request.id_project).then(function(upRequest) {
                           return res.json(upRequest);
                         });
                       }else {
-                        return res.json(savedRequest);
+                       
+                        return res.json(savedMessage);
                       }
-                    });
-                  }).catch(function(err){
-                    winston.error("Error creating message", {err: err, message: message});
-                    return res.status(500).send({success: false, msg: 'Error creating message', err:err });
-                  });
+                    // });
+              }).catch(function(err){ 
+                winston.error("Error creating chat21 webhook message: "+ JSON.stringify({err: err, message: message}));
+                return res.status(500).send({success: false, msg: 'Error creating message', err:err });
+              });
 
 
 
@@ -398,7 +404,9 @@ router.post('/', function (req, res) {
                       // winston.debug('updatedParticipantsRequest', updatedParticipantsRequest);
                       // manca id
 
-                      return requestService.closeRequestByRequestId(recipient_id, projectId).then(function(updatedStatusRequest) {
+                      // closeRequestByRequestId(request_id, id_project, skipStatsUpdate, notify, closed_by)
+                      const closed_by = user_id;
+                      return requestService.closeRequestByRequestId(recipient_id, projectId, false, true,closed_by ).then(function(updatedStatusRequest) {
                         
                         winston.debug('updatedStatusRequest', updatedStatusRequest.toObject());
                         return res.json(updatedStatusRequest);                      
@@ -532,7 +540,7 @@ router.post('/', function (req, res) {
     });
   }
   
-  else if (req.body.event_type == "deleted-archivedconversation") {
+  else if (req.body.event_type == "deleted-archivedconversation" || req.body.event_type == "conversation-unarchived") {
 
     winston.debug("event_type","deleted-archivedconversation");
 
@@ -544,7 +552,7 @@ router.post('/', function (req, res) {
     }
 
 
-      var conversation = req.body.data;
+      var conversation = req.body.data; 
       // winston.debug("conversation",conversation);
 
       var user_id = req.body.user_id;
@@ -561,16 +569,24 @@ router.post('/', function (req, res) {
         return res.status(400).send({success: false, msg: "not a support conversation" });
       }
 
+
+
       if (user_id!="system"){
         winston.debug("not a system conversation");
         return res.status(400).send({success: false, msg: "not a system conversation" });
       }
 
 
+
+     // scrivo... nuova viene popolato projectid in attributes poi chiudo ed in archived c'è projectid 
+      // quando scrivo viene cancellato archived e nuovo messaggio crea conv ma senza project id... lineare che è cosi
+      // si verifica solo se admin (da ionic ) archivia di nuovo senza che widget abbia scritto nulla (widget risetta projectid in properties)
+
       var id_project;
       if (conversation && conversation.attributes) {
         id_project = conversation.attributes.projectId;
       }else {
+        winston.debug( "not a support deleting archived conversation" );
         return res.status(400).send({success: false, msg: "not a support deleting archived conversation" });
       }
       winston.debug("id_project", id_project);