Source: plugins/wtapi.chat.js

  1. import WTAPI from '../wtapi'
  2. import {JSJaCMessage} from '../jsjac';
  4. /**
  5.  * A plugin that provides Chat functionality
  6.  *
  7.  * @version 1.0.0
  8.  */
  10. /**
  11.  * Constructor for Chat plugin.
  12.  * Instance will be created each time when new WTAPI instance is created. <br />
  13.  * Plugin could be accessible thought WTAPI with <b>chat</b> property.
  14.  *
  15.  * @tutorial chat-plugin
  16.  * @memberof WTAPI
  17.  * @alias WTAPI.ChatPlugin
  18.  * @augments Observer
  19.  * @public
  20.  * @constructor
  21.  */
  22. function ChatPlugin(wtapi) {
  23.     this._wtapi = wtapi;
  24.     this._wtapi.registerHandler("message", this._handleMessage, this, 100);
  25.     this._roster = this._wtapi.roster;
  27.     // Initialize supper
  28.     WTAPI.Observable.call(this);
  29. }
  31. ChatPlugin.prototype = Object.create(WTAPI.Observable.prototype);
  33. // ============================================================
  34. // Public events
  35. // ============================================================
  37. /**
  38.  * Indicates that new message is received from remote user.
  39.  *
  40.  * @event WTAPI.ChatPlugin#message_received
  41.  * @property {WTAPI.User} user
  42.  * @property {WTAPI.Message} message
  43.  */
  45. /**
  46.  * Indicates that message is read by destination.
  47.  *
  48.  * @event WTAPI.ChatPlugin#message_delivered
  49.  * @property {WTAPI.User} user
  50.  * @property {string} id Id message delivered
  51.  */
  53. // ============================================================
  54. // Public functions
  55. // ============================================================
  57. /**
  58.  * Sends a message to user.
  59.  *
  60.  * @param {WTAPI.User} user
  61.  * @param {WTAPI.Message} message
  62.  */
  63. ChatPlugin.prototype.send = function (user, message) {
  64.     var packet = new JSJaCMessage();
  65.     packet.setID(message.getId());
  66.     packet.setTo(user.getJid());
  67.     packet.setType('chat');
  68.     packet.setBody(message.getBody());
  70.     packet.appendNode('request', {'xmlns': 'urn:xmpp:receipts'});
  71.     packet.appendNode('markable', {'xmlns': 'urn:xmpp:chat-markers:0'});
  73.     this._wtapi.getConnection().send(packet);
  74. }
  76. /**
  77.  * Sends a notification that message are read by user.
  78.  *
  79.  * @param {WTAPI.User} user A user that send message
  80.  * @param {WTAPI.Message} message
  81.  */
  82. ChatPlugin.prototype.sendDeliveryConfirmation = function (user, message) {
  83.     var packet = new JSJaCMessage();
  84.     packet.setTo(user.getJid());
  85.     packet.setType('chat');
  86.     packet.appendNode('received', {'xmlns': 'urn:xmpp:receipts', 'id': message.getId()});
  87.     packet.appendNode('displayed', {'xmlns': 'urn:xmpp:chat-markers:0', 'id': message.getId()});
  88.     packet.appendNode('store', {'xmlns': 'urn:xmpp:hints'});
  90.     this._wtapi.getConnection().send(packet);
  91. }
  93. // ============================================================
  94. // ChatPlugin callbacks
  95. // ============================================================
  97. /**
  98.  * @private
  99.  */
  100. ChatPlugin.prototype._handleMessage = function (packet) {
  101.     if (this._handleMessageDelivery(packet)) {
  102.         return true;
  103.     }
  105.     // Default chat message handling
  106.     var type = packet.getType();
  107.     var body = packet.getBody();
  109.     if (!(type == "" || type == "chat" || type == "normal") || body.length == 0) {
  110.         return false;
  111.     }
  113.     var id = packet.getID();
  114.     var builder = new WTAPI.Message.Builder();
  115.     builder.withId(id);
  116.     builder.withBody(body);
  117.     var message = builder.build();
  119.     var nick = packet.getChildVal('nick', 'http://jabber.org/protocol/nick')
  120.     var from = packet.getFromJID();
  121.     var jid = from.removeResource().toString();
  122.     var user = this._roster.getUser(jid);
  124.     if (user === null) {
  125.         if (nick == '') {
  126.             nick = null;
  127.         }
  128.         user = this._roster.createUser(jid, nick);
  129.     }
  130.     this._fire("message_received", user, message);
  131. }
  133. /**
  134.  * @private
  135.  */
  136. ChatPlugin.prototype._handleMessageDelivery = function (packet) {
  137.     var els = packet.getNode().getElementsByTagName('received');
  138.     if (els.length == 1) {
  139.         if (els.item(0).namespaceURI != 'urn:xmpp:receipts') {
  140.             return false;
  141.         }
  142.     } else {
  143.         els = packet.getNode().getElementsByTagName('displayed');
  144.     }
  145.     if (els.length == 1) {
  146.         var received = els.item(0);
  147.         var id = received.getAttribute('id');
  148.         var from = packet.getFromJID();
  149.         var jid = from.removeResource().toString();
  150.         var user = this._roster.getUser(jid);
  152.         if (user && id) {
  153.             this._fire("message_delivered", user, id);
  154.         }
  155.     }
  156. }
  158. export default ChatPlugin;