feat(caps): Implement XEP-0115

JitsiConference.js

-/* global Strophe, $, Promise */
+/* global Strophe, Promise */
 
 var logger = require("jitsi-meet-logger").getLogger(__filename);
 import RTC from "./modules/RTC/RTC";
     participant._role = role;
     this.participants[id] = participant;
     this.eventEmitter.emit(JitsiConferenceEvents.USER_JOINED, id, participant);
-    // XXX Since disco is checked in multiple places (e.g.
-    // modules/xmpp/strophe.jingle.js, modules/xmpp/strophe.rayo.js), check it
-    // here as well.
-    var disco = this.xmpp.connection.disco;
-    if (disco) {
-        disco.info(
-            jid, "node", function(iq) {
-                participant._supportsDTMF = $(iq).find(
-                    '>query>feature[var="urn:xmpp:jingle:dtmf:0"]').length > 0;
-                this.updateDTMFSupport();
-            }.bind(this)
-        );
-    } else {
-      // FIXME Should participant._supportsDTMF be assigned false here (and
-      // this.updateDTMFSupport invoked)?
-    }
+    this.xmpp.caps.getFeatures(jid).then(features => {
+        participant._supportsDTMF = features.has("urn:xmpp:jingle:dtmf:0");
+        this.updateDTMFSupport();
+    }, error => logger.error(error));
 };
 
 JitsiConference.prototype.onMemberLeft = function (jid) {

JitsiConnection.js

     return this.xmpp.connectionTimes;
 };
 
+/**
+ * Adds new feature to the list of supported features for the local
+ * participant.
+ * @param {String} feature the name of the feature.
+ * @param {boolean} submit if true - the new list of features will be
+ * immediately submitted to the others.
+ */
+JitsiConnection.prototype.addFeature = function(feature, submit = false) {
+    return this.xmpp.caps.addFeature(feature, submit);
+};
+
+/**
+ * Removes a feature from the list of supported features for the local
+ * participant
+ * @param {String} feature the name of the feature.
+ * @param {boolean} submit if true - the new list of features will be
+ * immediately submitted to the others.
+ */
+JitsiConnection.prototype.removeFeature = function (feature, submit = false) {
+    return this.xmpp.caps.removeFeature(feature, submit);
+};
+
 module.exports = JitsiConnection;

JitsiParticipant.js

     supportsDTMF() {
         return this._supportsDTMF;
     }
+
+    /**
+     * Returns a set with the features for the participant.
+     * @param {int} timeout the timeout in ms for reply from the participant.
+     * @returns {Promise<Set<String>, Error>}
+     */
+    getFeatures(timeout = 5000) {
+        return this.conference.xmpp.caps.getFeatures(this._jid, timeout);
+    }
 }

doc/API.md

     - event - the event
     - listener - the listener that will be removed.
 
+7. addFeature - Adds new feature to the list of supported features for the local participant
+    - feature - string, the name of the feature
+    - submit - boolean, default false, if true - the new list of features will be immediately submitted to the others.
+
+8. removeFeature - Removes a feature from the list of supported features for the local participant
+    - feature - string, the name of the feature
+    - submit - boolean, default false, if true - the new list of features will be immediately submitted to the others.
+
 JitsiConference
 -----------
 The object represents a conference. We have the following methods to control the conference:

doc/example/index.html

     <meta charset="UTF-8">
     <title></title>
     <script src="libs/jquery-2.1.1.min.js"></script>
-    <script src="libs/strophe/strophe.min.js"></script>
+    <script src="libs/strophe/strophe.js"></script>
     <script src="libs/strophe/strophe.disco.min.js?v=1"></script>
-    <script src="libs/strophe/strophe.caps.jsonly.min.js?v=1"></script>
     <script src="../../lib-jitsi-meet.js"></script>
     <script src="example.js" ></script>
 </head>

doc/example/libs/strophe/strophe.caps.jsonly.min.js

-Strophe.addConnectionPlugin("caps",{HASH:"sha-1",node:"http://strophe.im/strophejs/",_ver:"",_connection:null,_knownCapabilities:{},_jidVerIndex:{},init:function(conn){this._connection=conn;Strophe.addNamespace("CAPS","http://jabber.org/protocol/caps");if(!this._connection.disco){throw"Caps plugin requires the disco plugin to be installed."}this._connection.disco.addFeature(Strophe.NS.CAPS);this._connection.addHandler(this._delegateCapabilities.bind(this),Strophe.NS.CAPS)},generateCapsAttrs:function(){return{xmlns:Strophe.NS.CAPS,hash:this.HASH,node:this.node,ver:this.generateVer()}},generateVer:function(){if(this._ver!==""){return this._ver}var ver="",identities=this._connection.disco._identities.sort(this._sortIdentities),identitiesLen=identities.length,features=this._connection.disco._features.sort(),featuresLen=features.length;for(var i=0;i<identitiesLen;i++){var curIdent=identities[i];ver+=curIdent.category+"/"+curIdent.type+"/"+curIdent.lang+"/"+curIdent.name+"<"}for(var i=0;i<featuresLen;i++){ver+=features[i]+"<"}this._ver=b64_sha1(ver);return this._ver},getCapabilitiesByJid:function(jid){if(this._jidVerIndex[jid]){return this._knownCapabilities[this._jidVerIndex[jid]]}return null},_delegateCapabilities:function(stanza){var from=stanza.getAttribute("from"),c=stanza.querySelector("c"),ver=c.getAttribute("ver"),node=c.getAttribute("node");if(!this._knownCapabilities[ver]){return this._requestCapabilities(from,node,ver)}else{this._jidVerIndex[from]=ver}if(!this._jidVerIndex[from]||!this._jidVerIndex[from]!==ver){this._jidVerIndex[from]=ver}return true},_requestCapabilities:function(to,node,ver){if(to!==this._connection.jid){var id=this._connection.disco.info(to,node+"#"+ver);this._connection.addHandler(this._handleDiscoInfoReply.bind(this),Strophe.NS.DISCO_INFO,"iq","result",id,to)}return true},_handleDiscoInfoReply:function(stanza){var query=stanza.querySelector("query"),node=query.getAttribute("node").split("#"),ver=node[1],from=stanza.getAttribute("from");if(!this._knownCapabilities[ver]){var childNodes=query.childNodes,childNodesLen=childNodes.length;this._knownCapabilities[ver]=[];for(var i=0;i<childNodesLen;i++){var node=childNodes[i];this._knownCapabilities[ver].push({name:node.nodeName,attributes:node.attributes})}this._jidVerIndex[from]=ver}else{if(!this._jidVerIndex[from]||!this._jidVerIndex[from]!==ver){this._jidVerIndex[from]=ver}}return false},_sortIdentities:function(a,b){if(a.category>b.category){return 1}if(a.category<b.category){return -1}if(a.type>b.type){return 1}if(a.type<b.type){return -1}if(a.lang>b.lang){return 1}if(a.lang<b.lang){return -1}return 0}});

modules/xmpp/Caps.js

+/* global $, b64_sha1, Strophe */
+import XMPPEvents from "../../service/xmpp/XMPPEvents";
+
+/**
+ * The property
+ */
+const IDENTITY_PROPERTIES = ["category", "type", "lang", "name"];
+const IDENTITY_PROPERTIES_FOR_COMPARE = ["category", "type", "lang"];
+const HASH = "sha-1";
+
+function compareIdentities(a, b) {
+    let res = 0;
+    IDENTITY_PROPERTIES_FOR_COMPARE.some(key =>
+        (res = ((a[key] > b[key]) && 1) || ((a[key] < b[key]) && -1)) !== 0
+    );
+    return res;
+}
+
+/**
+ * Implements xep-0115 ( http://xmpp.org/extensions/xep-0115.html )
+ */
+export default class Caps {
+    /**
+     * Constructs new Caps instance.
+     * @param {Strophe.Connection} connection the strophe connection object
+     * @param {String} node the value of the node attribute of the "c" xml node
+     * that will be sent to the other participants
+     */
+    constructor(connection = {}, node = "http://jitsi.org/jitsimeet") {
+        this.node = node;
+        this.disco = connection.disco;
+        if(!this.disco) {
+            throw new Error(
+                "Missing strophe-plugins "
+                + "(disco and caps plugins are required)!");
+        }
+
+        this.versionToCapabilities = Object.create(null);
+        this.jidToVersion = Object.create(null);
+        this.version = "";
+        this.rooms = new Set();
+
+        const emuc = connection.emuc;
+        emuc.addListener(XMPPEvents.EMUC_ROOM_ADDED,
+            room => this._addChatRoom(room));
+        emuc.addListener(XMPPEvents.EMUC_ROOM_REMOVED,
+            room => this._removeChatRoom(room));
+        for(let jid in emuc.rooms) {
+            this._addChatRoom(this.emuc.rooms[jid]);
+        }
+
+        Strophe.addNamespace("CAPS", "http://jabber.org/protocol/caps");
+        this.disco.addFeature(Strophe.NS.CAPS);
+        connection.addHandler(this._handleCaps.bind(this), Strophe.NS.CAPS);
+
+        this._onMucMemberLeft = this._removeJidToVersionEntry.bind(this);
+    }
+
+    /**
+     * Adds new feature to the list of supported features for the local
+     * participant
+     * @param {String} feature the name of the feature.
+     * @param {boolean} submit if true - new presence with updated "c" node
+     * will be sent.
+     */
+    addFeature(feature, submit = false) {
+        this.disco.addFeature(feature);
+        this._generateVersion();
+        if(submit) {
+            this.submit();
+        }
+    }
+
+    /**
+     * Removes a feature from the list of supported features for the local
+     * participant
+     * @param {String} feature the name of the feature.
+     * @param {boolean} submit if true - new presence with updated "c" node
+     * will be sent.
+     */
+    removeFeature(feature, submit = false) {
+        this.disco.removeFeature(feature);
+        this._generateVersion();
+        if(submit) {
+            this.submit();
+        }
+    }
+
+    /**
+     * Sends new presence stanza for every room from the list of rooms.
+     */
+    submit() {
+        this.rooms.forEach(room => room.sendPresence());
+    }
+
+    /**
+     * Returns a set with the features for a participant.
+     * @param {String} jid the jid of the participant
+     * @param {int} timeout the timeout in ms for reply from the participant.
+     * @returns {Promise<Set<String>, Error>}
+     */
+    getFeatures(jid, timeout = 5000) {
+        let user
+            = (jid in this.jidToVersion) ? this.jidToVersion[jid] : null;
+        if(!user || !(user.version in this.versionToCapabilities))
+        {
+            const node = (user)? user.node + "#" + user.version : null;
+            return new Promise ( (resolve, reject) =>
+                this.disco.info(jid, node, response => {
+                        const features = new Set();
+                        $(response).find(">query>feature").each((idx, el) =>
+                            features.add(el.getAttribute("var")));
+                        if(user) {
+                            this.versionToCapabilities[user.version]
+                                = features;
+                        }
+                        resolve(features);
+                    }, reject , timeout)
+            );
+        }
+        return Promise.resolve(this.versionToCapabilities[user.version]);
+    }
+
+    /**
+     * Adds ChatRoom instance to the list of rooms. Adds listeners to the room
+     * and adds "c" element to the presences of the room.
+     * @param {ChatRoom} room the room.
+     */
+    _addChatRoom(room) {
+        this.rooms.add(room);
+        room.addListener(XMPPEvents.MUC_MEMBER_LEFT, this._onMucMemberLeft);
+        this._fixChatRoomPresenceMap(room);
+    }
+
+    /**
+     * Removes ChatRoom instance from the list of rooms. Removes listeners
+     * added from the Caps class.
+     * @param {ChatRoom} room the room.
+     */
+    _removeChatRoom(room) {
+        this.rooms.delete(room);
+        room.removeListener(XMPPEvents.MUC_MEMBER_LEFT, this._onMucMemberLeft);
+    }
+
+    /**
+     * Creates/updates the "c" xml node into the presence of the passed room.
+     * @param {ChatRoom} room the room.
+     */
+    _fixChatRoomPresenceMap(room) {
+        room.addToPresence("c", {
+            attributes: {
+                xmlns: Strophe.NS.CAPS,
+                hash: HASH,
+                node: this.node,
+                ver: this.version
+            }
+        });
+    }
+
+    /**
+     * Handles this.version changes.
+     */
+    _notifyVersionChanged() {
+        //update the version for all rooms
+        this.rooms.forEach(room => this._fixChatRoomPresenceMap(room));
+        this.submit();
+    }
+
+    /**
+     * Generates the value for the "ver" attribute.
+     */
+    _generateVersion() {
+        const identities = this.disco._identities.sort(compareIdentities);
+        const features = this.disco._features.sort();
+        this.version = b64_sha1(
+            identities.reduce(
+                (accumulatedValue, identity) => {
+                    return IDENTITY_PROPERTIES.reduce((tmp, key, idx) => {
+                        return (idx === 0 ? "" : "/") + identity[key];
+                    }, "") + "<";
+                }, ""
+            ) + features.reduce((tmp, feature) => feature + "<", "")
+        );
+        this._notifyVersionChanged();
+    }
+
+    /**
+     * Parses the "c" xml node from presence.
+     * @param {DOMElement} stanza the presence packet
+     */
+    _handleCaps(stanza) {
+        const from = stanza.getAttribute("from");
+        const caps = stanza.querySelector("c");
+        const version = caps.getAttribute("ver");
+        const node = caps.getAttribute("node");
+        this.jidToVersion[from] = {version, node};
+        // return true to not remove the handler from Strophe
+        return true;
+    }
+
+    /**
+     * Removes entry from this.jidToVersion map.
+     * @param {String} jid the jid to be removed.
+     */
+    _removeJidToVersionEntry(jid) {
+        if(jid in this.jidToVersion) {
+            delete this.jidToVersion[jid];
+        }
+    }
+}

modules/xmpp/ChatRoom.js

             pres.up();
         }
 
-        // Send XEP-0115 'c' stanza that contains our capabilities info
-        var connection = this.connection;
-        var caps = connection.caps;
-        if (caps) {
-            caps.node = this.xmpp.options.clientNode;
-            pres.c('c', caps.generateCapsAttrs()).up();
-        }
-
         parser.JSON2packet(this.presMap.nodes, pres);
-        connection.send(pres);
+        this.connection.send(pres);
         if (fromJoin) {
             // XXX We're pressed for time here because we're beginning a complex
             // and/or lengthy conference-establishment process which supposedly
             // involves multiple RTTs. We don't have the time to wait for Strophe to
             // decide to send our IQ.
-            connection.flush();
+            this.connection.flush();
         }
     }
 

modules/xmpp/ConnectionPlugin.js

+import Listenable from "../util/Listenable";
+
 /**
- * Base class for strophe connection plugins.
+ * Creates ConnectionPlugin class that extends the passed class.
+ * @param {Class} base the definition of the class that will be extended by
+ * ConnectionPlugin
  */
-export default class ConnectionPlugin {
-    constructor() {
-        this.connection = null;
-    }
-    init (connection) {
-        this.connection = connection;
-    }
+function getConnectionPluginDefinition(base = class{}) {
+    /**
+     * Base class for strophe connection plugins.
+     */
+    return class extends base {
+        constructor(...args) {
+            super(...args);
+            this.connection = null;
+        }
+        init (connection) {
+            this.connection = connection;
+        }
+    };
 }
+
+/**
+ * ConnectionPlugin class.
+ */
+export default getConnectionPluginDefinition();
+
+/**
+ * ConnectionPlugin class that extends Listenable.
+ */
+export const ConnectionPluginListenable
+    = getConnectionPluginDefinition(Listenable);

modules/xmpp/strophe.emuc.js

 import {getLogger} from "jitsi-meet-logger";
 const logger = getLogger(__filename);
 import ChatRoom from "./ChatRoom";
-import ConnectionPlugin from "./ConnectionPlugin";
+import {ConnectionPluginListenable} from "./ConnectionPlugin";
+import XMPPEvents from "../../service/xmpp/XMPPEvents";
 
-class MucConnectionPlugin extends ConnectionPlugin {
+class MucConnectionPlugin extends ConnectionPluginListenable {
     constructor(xmpp) {
         super();
         this.xmpp = xmpp;
         }
         this.rooms[roomJid] = new ChatRoom(this.connection, jid,
             password, this.xmpp, options);
+        this.eventEmitter.emit(
+            XMPPEvents.EMUC_ROOM_ADDED, this.rooms[roomJid]);
         return this.rooms[roomJid];
     }
 
     doLeave (jid) {
+        this.eventEmitter.emit(
+            XMPPEvents.EMUC_ROOM_REMOVED, this.rooms[jid]);
         delete this.rooms[jid];
     }
 

modules/xmpp/strophe.ping.js

-/* global $, $iq, Strophe */
+/* global $iq, Strophe */
 
 import { getLogger } from "jitsi-meet-logger";
 const logger = getLogger(__filename);
  */
 const PING_THRESHOLD = 3;
 
-
-
-
 /**
  * XEP-0199 ping plugin.
  *
  * Registers "urn:xmpp:ping" namespace under Strophe.NS.PING.
  */
 class PingConnectionPlugin extends ConnectionPlugin {
-    constructor() {
+    /**
+     * Contructs new object
+     * @param {XMPP} xmpp the xmpp module.
+     * @constructor
+     */
+    constructor(xmpp) {
         super();
         this.failedPings = 0;
+        this.xmpp = xmpp;
     }
 
     /**
      * <tt>true</tt> if XEP-0199 ping is supported by given <tt>jid</tt>
      */
     hasPingSupport (jid, callback) {
-        const disco = this.connection.disco;
-        // XXX The following disco.info was observed to throw a "TypeError:
-        // Cannot read property 'info' of undefined" during porting to React
-        // Native. Since disco is checked in multiple places (e.g.
-        // strophe.jingle.js, strophe.rayo.js), check it here as well.
-        if (disco) {
-            disco.info(jid, null, (result)  => {
-                const ping
-                    = $(result).find('>>feature[var="urn:xmpp:ping"]');
-                callback(ping.length > 0);
-            }, (error) => {
-                const errmsg = "Ping feature discovery error";
-                GlobalOnErrorHandler.callErrorHandler(new Error(
-                    errmsg + ": " + error));
-                logger.error(errmsg, error);
-                callback(false);
-            });
-        } else {
-          // FIXME Should callback be invoked here? Maybe with false as an
-          // argument?
-        }
+        this.xmpp.caps.getFeatures(jid).then(features =>
+            callback(features.has("urn:xmpp:ping")), error => {
+            const errmsg = "Ping feature discovery error";
+            GlobalOnErrorHandler.callErrorHandler(new Error(
+                errmsg + ": " + error));
+            logger.error(errmsg, error);
+            callback(false);
+        });
     }
 
     /**
     }
 }
 
-export default function () {
-    Strophe.addConnectionPlugin('ping', new PingConnectionPlugin());
+export default function (xmpp) {
+    Strophe.addConnectionPlugin('ping', new PingConnectionPlugin(xmpp));
 }

modules/xmpp/strophe.rayo.js

 class RayoConnectionPlugin extends ConnectionPlugin {
     init (connection) {
         super.init(connection);
-        const disco = this.connection.disco;
-        if (disco) {
-            disco.addFeature('urn:xmpp:rayo:client:1');
-        }
 
         this.connection.addHandler(
             this.onRayo.bind(this), RAYO_XMLNS, 'iq', 'set', null, null);

modules/xmpp/xmpp.js

 import initRayo from "./strophe.rayo";
 import initStropheLogger from "./strophe.logger";
 import Listenable from "../util/Listenable";
+import Caps from "./Caps";
 
 function createConnection(token, bosh = '/http-bind') {
     // Append token as URL param
 
         this.connection = createConnection(token, options.bosh);
 
-        if(!this.connection.disco || !this.connection.caps)
-            throw new Error(
-                "Missing strophe-plugins (disco and caps plugins are required)!");
+        this.caps = new Caps(this.connection, this.options.clientNode);
 
         // Initialize features advertised in disco-info
         this.initFeaturesList();
      * Initializes the list of feature advertised through the disco-info mechanism
      */
     initFeaturesList () {
-        const disco = this.connection.disco;
-        if (!disco)
-            return;
-
         // http://xmpp.org/extensions/xep-0167.html#support
         // http://xmpp.org/extensions/xep-0176.html#support
-        disco.addFeature('urn:xmpp:jingle:1');
-        disco.addFeature('urn:xmpp:jingle:apps:rtp:1');
-        disco.addFeature('urn:xmpp:jingle:transports:ice-udp:1');
-        disco.addFeature('urn:xmpp:jingle:apps:dtls:0');
-        disco.addFeature('urn:xmpp:jingle:transports:dtls-sctp:1');
-        disco.addFeature('urn:xmpp:jingle:apps:rtp:audio');
-        disco.addFeature('urn:xmpp:jingle:apps:rtp:video');
+        this.caps.addFeature('urn:xmpp:jingle:1');
+        this.caps.addFeature('urn:xmpp:jingle:apps:rtp:1');
+        this.caps.addFeature('urn:xmpp:jingle:transports:ice-udp:1');
+        this.caps.addFeature('urn:xmpp:jingle:apps:dtls:0');
+        this.caps.addFeature('urn:xmpp:jingle:transports:dtls-sctp:1');
+        this.caps.addFeature('urn:xmpp:jingle:apps:rtp:audio');
+        this.caps.addFeature('urn:xmpp:jingle:apps:rtp:video');
 
         if (RTCBrowserType.isChrome() || RTCBrowserType.isOpera()
             || RTCBrowserType.isTemasysPluginUsed()) {
-            disco.addFeature('urn:ietf:rfc:4588');
+            this.caps.addFeature('urn:ietf:rfc:4588');
         }
 
         // this is dealt with by SDP O/A so we don't need to announce this
-        //disco.addFeature('urn:xmpp:jingle:apps:rtp:rtcp-fb:0'); // XEP-0293
-        //disco.addFeature('urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'); // XEP-0294
+        // XEP-0293
+        //this.caps.addFeature('urn:xmpp:jingle:apps:rtp:rtcp-fb:0');
+        // XEP-0294
+        //this.caps.addFeature('urn:xmpp:jingle:apps:rtp:rtp-hdrext:0');
 
-        disco.addFeature('urn:ietf:rfc:5761'); // rtcp-mux
-        disco.addFeature('urn:ietf:rfc:5888'); // a=group, e.g. bundle
+        this.caps.addFeature('urn:ietf:rfc:5761'); // rtcp-mux
+        this.caps.addFeature('urn:ietf:rfc:5888'); // a=group, e.g. bundle
 
-        //disco.addFeature('urn:ietf:rfc:5576'); // a=ssrc
+        //this.caps.addFeature('urn:ietf:rfc:5576'); // a=ssrc
 
         // Enable Lipsync ?
         if (RTCBrowserType.isChrome() && false !== this.options.enableLipSync) {
             logger.info("Lip-sync enabled !");
-            disco.addFeature('http://jitsi.org/meet/lipsync');
+            this.caps.addFeature('http://jitsi.org/meet/lipsync');
+        }
+
+        if(this.connection.rayo) {
+            this.caps.addFeature('urn:xmpp:rayo:client:1');
         }
     }
 
         initEmuc(this);
         initJingle(this, this.eventEmitter);
         initStropheUtil();
-        initPing(this, this.eventEmitter);
+        initPing(this);
         initRayo();
         initStropheLogger();
     }

service/xmpp/XMPPEvents.js

     // Designates an event indicating that the display name of a participant
     // has changed.
     DISPLAY_NAME_CHANGED: "xmpp.display_name_changed",
+    /**
+     * Chat room instance have been added to Strophe.emuc plugin.
+     */
+    EMUC_ROOM_ADDED: "xmpp.emuc_room_added",
+    /**
+     * Chat room instance have been removed from Strophe.emuc plugin.
+     */
+    EMUC_ROOM_REMOVED: "xmpp.emuc_room_removed",
     ETHERPAD: "xmpp.etherpad",
     FOCUS_DISCONNECTED: 'xmpp.focus_disconnected',
     FOCUS_LEFT: "xmpp.focus_left",