modules/push-gateways/lib/notification-message-generator.js

   1 'use strict';
   2
   3 /**
   4
   5 Examples of notifications:
   6
   7 ------------------------------------------
   8 Souper Troupers
   9 Mike: Yo
  10 Andrew: Yo how are you...
  11 Andrew uploaded account.xls
  12 ------------------------------------------
  13 Souper Troupers
  14 Mike: Yo
  15 ------------------------------------------
  16 Souper Troupers
  17 Andrew uploaded account.xls
  18 Andrew uploaded account2.xls
  19 ------------------------------------------
  20 Mike Bartlett:
  21 Mike: hey how are you?
  22 Mike: blah?
  23 Mike: ?
  24 */
  25
  26 var MAX_NOTIFICATION_TEXT = 1024;
  27 var LAST_LINE_MIN_LENGTH = 30;
  28
  29 var ent = require('ent');
  30
  31 function truncate(line, maxLineLength) {
  32   if (line.length > maxLineLength) {
  33     line = line.substring(0, maxLineLength - 1).trim() + '…';
  34   }
  35   return line;
  36 }
  37
  38 function getHeaderLine(troupe) {
  39   return troupe.name || troupe.uri;
  40 }
  41
  42 function getText(username, chat) {
  43   if (!chat.text) return;
  44   var encodedText = ent.decode(chat.text); // Do we need to do this?
  45   if (username) {
  46     return username + ': ' + encodedText;
  47   } else {
  48     return encodedText;
  49   }
  50 }
  51
  52 function getShortFromUserName(user) {
  53   if (!user) return;
  54
  55   var displayName = user.displayName;
  56   if (!displayName) return '';
  57
  58   // this is dodgy, btw. See #373
  59   //return displayName && displayName.split(/\s/,1)[0];
  60   return displayName.trim();
  61 }
  62
  63 // eslint-disable-next-line complexity
  64 function summarizeChatsInRoom(troupe, chats, options) {
  65   var appendText = options && options.appendText;
  66   var maxMessageLength = (options && options.maxMessageLength) || MAX_NOTIFICATION_TEXT;
  67   var maxLength = maxMessageLength - (appendText ? appendText.length : 0);
  68
  69   //
  70   // Generate notification text
  71   //
  72   var notificationText = getHeaderLine(troupe) || '';
  73   var lastUsername = null;
  74   for (
  75     var i = 0;
  76     i < chats.length && notificationText.length <= maxLength - LAST_LINE_MIN_LENGTH;
  77     i++
  78   ) {
  79     var chat = chats[i];
  80
  81     // Only group chats prefix the username
  82     var username = troupe.oneToOne ? null : getShortFromUserName(chat.fromUser);
  83     if (username === lastUsername) {
  84       username = null; // Don't prefix the username if it's the same as the last message
  85     } else {
  86       lastUsername = username;
  87     }
  88
  89     var text = getText(username, chat);
  90     if (!text) continue;
  91
  92     if (notificationText.length + text.length > maxLength) {
  93       text = truncate(text, maxLength - notificationText.length - 3 /* newline etc */);
  94       // We add extra spaces so that when they're removed on an iphone the notificationText still makes sense
  95     }
  96
  97     notificationText = notificationText ? notificationText + '  \n' + text : text;
  98   }
  99
 100   if (appendText) {
 101     notificationText += appendText;
 102   }
 103
 104   return notificationText;
 105 }
 106
 107 module.exports = summarizeChatsInRoom;