Refactor the API out into a separate module, src/convers-api.js

Plugins are now also updated so that they can get the closured converse object
directly and don't need to rely on _super.

converse.js

@@ -4,6 +4,8 @@
  * when it generates a build.
  */
 define("converse", [
+    "converse-api",
+
     /* Removable components
      * --------------------
      * Any of the following components may be removed if they're not needed.
@@ -13,8 +15,7 @@ define("converse", [
     "converse-register",// XEP-0077 In-band registration
     "converse-ping",    // XEP-0199 XMPP Ping
     /* End: Removable components */
-
-    "converse-core"
-], function() {
-    return arguments[arguments.length-1];
+], function(converse_api) {
+    window.converse = converse_api;
+    return converse_api;
 });

main.js

@@ -45,6 +45,7 @@ require.config({
         
         // Converse
         "converse-core":            "src/converse-core",
+        "converse-api":             "src/converse-api",
         "converse-muc":             "src/converse-muc",
         "converse-otr":             "src/converse-otr",
         "converse-ping":            "src/converse-ping",
@@ -201,9 +202,3 @@ require.config({
         'strophe.vcard':        { deps: ['strophe'] }
     }
 });
-
-if (typeof(require) === 'function') {
-    require(["converse"], function(converse_api) {
-        window.converse = converse_api;
-    });
-}

src/converse-api.js

@@ -0,0 +1,199 @@
+// Converse.js (A browser based XMPP chat client)
+// http://conversejs.org
+//
+// Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
+// Licensed under the Mozilla Public License (MPLv2)
+//
+/*global define */
+
+/* This is a Converse.js plugin which add support for multi-user chat rooms, as
+ * specified in XEP-0045 Multi-user chat.
+ */
+(function (root, factory) {
+    define("converse-api", [
+            "jquery",
+            "underscore",
+            "moment_with_locales",
+            "strophe",
+            "utils",
+            "converse-core"
+        ],
+        factory);
+}(this, function ($, _, moment, strophe, utils, converse) {
+    var Strophe = strophe.Strophe;
+    return {
+        'initialize': function (settings, callback) {
+            converse.initialize(settings, callback);
+        },
+        'disconnect': function () {
+              converse.connection.disconnect();
+        },
+        'user': {
+            'logout': function () {
+                converse.logOut();
+            },
+            'status': {
+                'get': function () {
+                    return converse.xmppstatus.get('status');
+                },
+                'set': function (value, message) {
+                    var data = {'status': value};
+                    if (!_.contains(_.keys(converse.STATUS_WEIGHTS), value)) {
+                        throw new Error('Invalid availability value. See https://xmpp.org/rfcs/rfc3921.html#rfc.section.2.2.2.1');
+                    }
+                    if (typeof message === "string") {
+                        data.status_message = message;
+                    }
+                    converse.xmppstatus.save(data);
+                },
+                'message': {
+                    'get': function () {
+                        return converse.xmppstatus.get('status_message');
+                    },
+                    'set': function (stat) {
+                        converse.xmppstatus.save({'status_message': stat});
+                    }
+                }
+            },
+        },
+        'settings': {
+            'get': function (key) {
+                if (_.contains(Object.keys(converse.default_settings), key)) {
+                    return converse[key];
+                }
+            },
+            'set': function (key, val) {
+                var o = {};
+                if (typeof key === "object") {
+                    _.extend(converse, _.pick(key, Object.keys(converse.default_settings)));
+                } else if (typeof key === "string") {
+                    o[key] = val;
+                    _.extend(converse, _.pick(o, Object.keys(converse.default_settings)));
+                }
+            }
+        },
+        'contacts': {
+            'get': function (jids) {
+                var _transform = function (jid) {
+                    var contact = converse.roster.get(Strophe.getBareJidFromJid(jid));
+                    if (contact) {
+                        return contact.attributes;
+                    }
+                    return null;
+                };
+                if (typeof jids === "undefined") {
+                    jids = converse.roster.pluck('jid');
+                } else if (typeof jids === "string") {
+                    return _transform(jids);
+                }
+                return _.map(jids, _transform);
+            },
+            'add': function (jid, name) {
+                if (typeof jid !== "string" || jid.indexOf('@') < 0) {
+                    throw new TypeError('contacts.add: invalid jid');
+                }
+                converse.roster.addAndSubscribe(jid, _.isEmpty(name)? jid: name);
+            }
+        },
+        'chats': {
+            'open': function (jids) {
+                var chatbox;
+                if (typeof jids === "undefined") {
+                    converse.log("chats.open: You need to provide at least one JID", "error");
+                    return null;
+                } else if (typeof jids === "string") {
+                    chatbox = converse.wrappedChatBox(converse.chatboxes.getChatBox(jids, true));
+                    chatbox.open();
+                    return chatbox;
+                }
+                return _.map(jids, function (jid) {
+                    chatbox = converse.wrappedChatBox(converse.chatboxes.getChatBox(jid, true));
+                    chatbox.open();
+                    return chatbox;
+                });
+            },
+            'get': function (jids) {
+                if (typeof jids === "undefined") {
+                    converse.log("chats.get: You need to provide at least one JID", "error");
+                    return null;
+                } else if (typeof jids === "string") {
+                    return converse.wrappedChatBox(converse.chatboxes.getChatBox(jids, true));
+                }
+                return _.map(jids, _.partial(_.compose(converse.wrappedChatBox, converse.chatboxes.getChatBox.bind(converse.chatboxes)), _, true));
+            }
+        },
+        'archive': {
+            'query': converse.queryForArchivedMessages.bind(converse)
+        },
+        'tokens': {
+            'get': function (id) {
+                if (!converse.expose_rid_and_sid || typeof converse.connection === "undefined") {
+                    return null;
+                }
+                if (id.toLowerCase() === 'rid') {
+                    return converse.connection.rid || converse.connection._proto.rid;
+                } else if (id.toLowerCase() === 'sid') {
+                    return converse.connection.sid || converse.connection._proto.sid;
+                }
+            }
+        },
+        'listen': {
+            'once': function (evt, handler) {
+                converse.once(evt, handler);
+            },
+            'on': function (evt, handler) {
+                converse.on(evt, handler);
+            },
+            'not': function (evt, handler) {
+                converse.off(evt, handler);
+            },
+        },
+        'send': function (stanza) {
+            converse.connection.send(stanza);
+        },
+        'plugins': {
+            'add': function (name, plugin) {
+                converse.plugins[name] = plugin;
+            },
+            'remove': function (name) {
+                delete converse.plugins[name];
+            },
+            'override': function (name, value) {
+                /* Helper method for overriding methods and attributes directly on the
+                 * converse object. For Backbone objects, use instead the 'extend'
+                 * method.
+                 *
+                 * If a method is overridden, then the original method will still be
+                 * available via the _super attribute.
+                 *
+                 * name: The attribute being overridden.
+                 * value: The value of the attribute being overridden.
+                 */
+                converse._overrideAttribute(name, value);
+            },
+            'extend': function (obj, attributes) {
+                /* Helper method for overriding or extending Converse's Backbone Views or Models
+                 *
+                 * When a method is overriden, the original will still be available
+                 * on the _super attribute of the object being overridden.
+                 *
+                 * obj: The Backbone View or Model
+                 * attributes: A hash of attributes, such as you would pass to Backbone.Model.extend or Backbone.View.extend
+                 */
+                converse._extendObject(obj, attributes);
+            }
+        },
+        'env': {
+            '$build': strophe.$build,
+            '$iq': strophe.$iq,
+            '$msg': strophe.$msg,
+            '$pres': strophe.$pres,
+            'Strophe': strophe.Strophe,
+            'b64_sha1':  strophe.SHA1.b64_sha1,
+            '_': _,
+            'jQuery': $,
+            'moment': moment,
+            'utils': utils
+        }
+    };
+}));

src/converse-controlbox.js

@@ -0,0 +1,13 @@
+// Converse.js (A browser based XMPP chat client)
+// http://conversejs.org
+//
+// Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
+// Licensed under the Mozilla Public License (MPLv2)
+//
+/*global define */
+
+(function (root, factory) {
+    define("converse-muc", ["converse-core"], factory);
+}(this, function (converse_api) {
+    "use strict";
+}));

src/converse-core.js

@@ -4,48 +4,34 @@
 // Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global Backbone, define, window, jQuery, setTimeout, clearTimeout, document, templates, _,
-  $iq, $msg, $pres, $build, Strophe, moment, utils, b64_sha1, locales */
+/*global Backbone, define, window, document, locales */
 
 (function (root, factory) {
-    if (typeof define === 'function' && define.amd) {
-        // AMD module loading
-        // ------------------
-        // When using require.js, two modules are loaded as dependencies.
-        //
-        // * **converse-dependencies**: A list of dependencies on which converse.js
-        //   depends. The path to this module is in main.js and the module itself can
-        //   be overridden.
-        // * **converse-templates**: The HTML templates used by converse.js.
-        //
-        // The dependencies are then split up and passed into the factory function,
-        // which contains and instantiates converse.js.
-        define("converse-core",
-              ["converse-dependencies", "converse-templates"],
-            function (dependencies, templates) {
-                return factory(
-                    templates,
-                    dependencies.jQuery,
-                    dependencies.$iq,
-                    dependencies.$msg,
-                    dependencies.$pres,
-                    dependencies.$build,
-                    dependencies.Strophe,
-                    dependencies.underscore,
-                    dependencies.moment,
-                    dependencies.utils,
-                    dependencies.SHA1.b64_sha1
-                );
-            }
-        );
-    } else {
-        // When not using a module loader
-        // -------------------------------
-        // In this case, the dependencies need to be available already as
-        // global variables, and should be loaded separately via *script* tags.
-        // See the file **non_amd.html** for an example of this usecase.
-        root.converse = factory(templates, jQuery, $iq, $msg, $pres, $build, Strophe, _, moment, utils, b64_sha1);
-    }
+    // Two modules are loaded as dependencies.
+    //
+    // * **converse-dependencies**: A list of dependencies converse.js depends on.
+    //   The path to this module is in main.js and the module itself can be overridden.
+    // * **converse-templates**: The HTML templates used by converse.js.
+    //
+    // The dependencies are then split up and passed into the factory function,
+    // which contains and instantiates converse.js.
+    define("converse-core", ["converse-dependencies", "converse-templates"],
+        function (dependencies, templates) {
+            return factory(
+                templates,
+                dependencies.jQuery,
+                dependencies.$iq,
+                dependencies.$msg,
+                dependencies.$pres,
+                dependencies.$build,
+                dependencies.Strophe,
+                dependencies.underscore,
+                dependencies.moment,
+                dependencies.utils,
+                dependencies.SHA1.b64_sha1
+            );
+        }
+    );
 }(this, function (templates, $, $iq, $msg, $pres, $build, Strophe, _, moment, utils, b64_sha1) {
     /* "use strict";
      * Cannot use this due to Safari bug.
@@ -89,14 +75,8 @@
         }
     };
 
-    // Global constants
-
-    // XEP-0059 Result Set Management
-    var RSM_ATTRIBUTES = ['max', 'first', 'last', 'after', 'before', 'index', 'count'];
-    // XEP-0313 Message Archive Management
-    var MAM_ATTRIBUTES = ['with', 'start', 'end'];
-
-    var STATUS_WEIGHTS = {
+    // Module-level constants
+    converse.STATUS_WEIGHTS = {
         'offline':      6,
         'unavailable':  5,
         'xa':           4,
@@ -106,6 +86,92 @@
         'online':       1
     };
 
+    // TODO Refactor into external MAM plugin
+    // XEP-0059 Result Set Management
+    var RSM_ATTRIBUTES = ['max', 'first', 'last', 'after', 'before', 'index', 'count'];
+    // XEP-0313 Message Archive Management
+    var MAM_ATTRIBUTES = ['with', 'start', 'end'];
+    converse.queryForArchivedMessages = function (options, callback, errback) {
+        /* Do a MAM (XEP-0313) query for archived messages.
+            *
+            * Parameters:
+            *    (Object) options - Query parameters, either MAM-specific or also for Result Set Management.
+            *    (Function) callback - A function to call whenever we receive query-relevant stanza.
+            *    (Function) errback - A function to call when an error stanza is received.
+            *
+            * The options parameter can also be an instance of
+            * Strophe.RSM to enable easy querying between results pages.
+            *
+            * The callback function may be called multiple times, first
+            * for the initial IQ result and then for each message
+            * returned. The last time the callback is called, a
+            * Strophe.RSM object is returned on which "next" or "previous"
+            * can be called before passing it in again to this method, to
+            * get the next or previous page in the result set.
+            */
+        var date, messages = [];
+        if (typeof options === "function") {
+            callback = options;
+            errback = callback;
+        }
+        if (!converse.features.findWhere({'var': Strophe.NS.MAM})) {
+            throw new Error('This server does not support XEP-0313, Message Archive Management');
+        }
+        var queryid = converse.connection.getUniqueId();
+        var attrs = {'type':'set'};
+        if (typeof options !== "undefined" && options.groupchat) {
+            if (!options['with']) {
+                throw new Error('You need to specify a "with" value containing the chat room JID, when querying groupchat messages.');
+            }
+            attrs.to = options['with'];
+        }
+        var stanza = $iq(attrs).c('query', {'xmlns':Strophe.NS.MAM, 'queryid':queryid});
+        if (typeof options !== "undefined") {
+            stanza.c('x', {'xmlns':Strophe.NS.XFORM, 'type': 'submit'})
+                    .c('field', {'var':'FORM_TYPE', 'type': 'hidden'})
+                    .c('value').t(Strophe.NS.MAM).up().up();
+
+            if (options['with'] && !options.groupchat) {
+                stanza.c('field', {'var':'with'}).c('value').t(options['with']).up().up();
+            }
+            _.each(['start', 'end'], function (t) {
+                if (options[t]) {
+                    date = moment(options[t]);
+                    if (date.isValid()) {
+                        stanza.c('field', {'var':t}).c('value').t(date.format()).up().up();
+                    } else {
+                        throw new TypeError('archive.query: invalid date provided for: '+t);
+                    }
+                }
+            });
+            stanza.up();
+            if (options instanceof Strophe.RSM) {
+                stanza.cnode(options.toXML());
+            } else if (_.intersection(RSM_ATTRIBUTES, _.keys(options)).length) {
+                stanza.cnode(new Strophe.RSM(options).toXML());
+            }
+        }
+        converse.connection.addHandler(function (message) {
+            var $msg = $(message), $fin, rsm;
+            if (typeof callback === "function") {
+                $fin = $msg.find('fin[xmlns="'+Strophe.NS.MAM+'"]');
+                if ($fin.length) {
+                    rsm = new Strophe.RSM({xml: $fin.find('set')[0]});
+                    _.extend(rsm, _.pick(options, ['max']));
+                    _.extend(rsm, _.pick(options, MAM_ATTRIBUTES));
+                    callback(messages, rsm);
+                    return false; // We've received all messages, decommission this handler
+                } else if (queryid === $msg.find('result').attr('queryid')) {
+                    messages.push(message);
+                }
+                return true;
+            } else {
+                return false; // There's no callback, so no use in continuing this handler.
+            }
+        }, Strophe.NS.MAM);
+        converse.connection.sendIQ(stanza, null, errback);
+    };
+
     converse.initialize = function (settings, callback) {
         "use strict";
         var converse = this;
@@ -376,7 +442,7 @@
         // Module-level functions
         // ----------------------
 
-	this.generateResource = function () {
+        this.generateResource = function () {
             return '/converse.js-' + Math.floor(Math.random()*139749825).toString();
         };
 
@@ -547,8 +613,8 @@
         this.reconnect = function (condition) {
             converse.log('Attempting to reconnect in 5 seconds');
             converse.giveFeedback(__('Attempting to reconnect in 5 seconds'), 'error');
-            clearTimeout(converse.reconnectTimeout);
-            converse.reconnectTimeout = setTimeout(function () {
+            window.clearTimeout(converse.reconnectTimeout);
+            converse.reconnectTimeout = window.setTimeout(function () {
                 if (converse.authentication !== "prebind") {
                     this.connection.connect(
                         this.connection.jid,
@@ -582,7 +648,7 @@
                 converse.send_initial_presence = true;
                 delete converse.disconnection_cause;
                 if (!!converse.reconnectTimeout) {
-                    clearTimeout(converse.reconnectTimeout);
+                    window.clearTimeout(converse.reconnectTimeout);
                     delete converse.reconnectTimeout;
                 }
                 if ((typeof reconnect !== 'undefined') && (reconnect)) {
@@ -992,7 +1058,7 @@
                 this.renderToolbar().renderAvatar();
                 this.$content.on('scroll', _.debounce(this.onScroll.bind(this), 100));
                 converse.emit('chatBoxOpened', this);
-                setTimeout(converse.refreshWebkit, 50);
+                window.setTimeout(converse.refreshWebkit, 50);
                 return this.showStatusMessage();
             },
 
@@ -1049,7 +1115,7 @@
                     return;
                 }
                 this.addSpinner();
-                API.archive.query(options, function (messages) {
+                converse.queryForArchivedMessages(options, function (messages) {
                         this.clearSpinner();
                         if (messages.length) {
                             _.map(messages, converse.chatboxes.onMessage.bind(converse.chatboxes));
@@ -1322,13 +1388,13 @@
                  *    (Object) message - The message Backbone object that was added.
                  */
                 if (typeof this.clear_status_timeout !== 'undefined') {
-                    clearTimeout(this.clear_status_timeout);
+                    window.clearTimeout(this.clear_status_timeout);
                     delete this.clear_status_timeout;
                 }
                 if (!message.get('message')) {
                     if (message.get('chat_state') === COMPOSING) {
                         this.showStatusNotification(message.get('fullname')+' '+__('is typing'));
-                        this.clear_status_timeout = setTimeout(this.clearStatusNotification.bind(this), 10000);
+                        this.clear_status_timeout = window.setTimeout(this.clearStatusNotification.bind(this), 10000);
                         return;
                     } else if (message.get('chat_state') === PAUSED) {
                         this.showStatusNotification(message.get('fullname')+' '+__('has stopped typing'));
@@ -1446,14 +1512,14 @@
                  *    (Boolean) no_save - Just do the cleanup or setup but don't actually save the state.
                  */
                 if (typeof this.chat_state_timeout !== 'undefined') {
-                    clearTimeout(this.chat_state_timeout);
+                    window.clearTimeout(this.chat_state_timeout);
                     delete this.chat_state_timeout;
                 }
                 if (state === COMPOSING) {
-                    this.chat_state_timeout = setTimeout(
+                    this.chat_state_timeout = window.setTimeout(
                             this.setChatState.bind(this), converse.TIMEOUTS.PAUSED, PAUSED);
                 } else if (state === PAUSED) {
-                    this.chat_state_timeout = setTimeout(
+                    this.chat_state_timeout = window.setTimeout(
                             this.setChatState.bind(this), converse.TIMEOUTS.INACTIVE, INACTIVE);
                 }
                 if (!no_save && this.model.get('chat_state') !== state) {
@@ -2778,12 +2844,12 @@
                 var name1, name2;
                 var status1 = contact1.get('chat_status') || 'offline';
                 var status2 = contact2.get('chat_status') || 'offline';
-                if (STATUS_WEIGHTS[status1] === STATUS_WEIGHTS[status2]) {
+                if (converse.STATUS_WEIGHTS[status1] === converse.STATUS_WEIGHTS[status2]) {
                     name1 = contact1.get('fullname').toLowerCase();
                     name2 = contact2.get('fullname').toLowerCase();
                     return name1 < name2 ? -1 : (name1 > name2? 1 : 0);
                 } else  {
-                    return STATUS_WEIGHTS[status1] < STATUS_WEIGHTS[status2] ? -1 : 1;
+                    return converse.STATUS_WEIGHTS[status1] < converse.STATUS_WEIGHTS[status2] ? -1 : 1;
                 }
             },
 
@@ -4372,259 +4438,5 @@
         this.registerGlobalEventHandlers();
         converse.emit('initialized');
     };
-
-    var API = {
-        'initialize': function (settings, callback) {
-            converse.initialize(settings, callback);
-        },
-        'disconnect': function () {
-              converse.connection.disconnect();
-        },
-        'user': {
-            'logout': function () {
-                converse.logOut();
-            },
-            'status': {
-                'get': function () {
-                    return converse.xmppstatus.get('status');
-                },
-                'set': function (value, message) {
-                    var data = {'status': value};
-                    if (!_.contains(_.keys(STATUS_WEIGHTS), value)) {
-                        throw new Error('Invalid availability value. See https://xmpp.org/rfcs/rfc3921.html#rfc.section.2.2.2.1');
-                    }
-                    if (typeof message === "string") {
-                        data.status_message = message;
-                    }
-                    converse.xmppstatus.save(data);
-                },
-                'message': {
-                    'get': function () {
-                        return converse.xmppstatus.get('status_message');
-                    },
-                    'set': function (stat) {
-                        converse.xmppstatus.save({'status_message': stat});
-                    }
-                }
-            },
-        },
-        'settings': {
-            'get': function (key) {
-                if (_.contains(Object.keys(converse.default_settings), key)) {
-                    return converse[key];
-                }
-            },
-            'set': function (key, val) {
-                var o = {};
-                if (typeof key === "object") {
-                    _.extend(converse, _.pick(key, Object.keys(converse.default_settings)));
-                } else if (typeof key === "string") {
-                    o[key] = val;
-                    _.extend(converse, _.pick(o, Object.keys(converse.default_settings)));
-                }
-            }
-        },
-        'contacts': {
-            'get': function (jids) {
-                var _transform = function (jid) {
-                    var contact = converse.roster.get(Strophe.getBareJidFromJid(jid));
-                    if (contact) {
-                        return contact.attributes;
-                    }
-                    return null;
-                };
-                if (typeof jids === "undefined") {
-                    jids = converse.roster.pluck('jid');
-                } else if (typeof jids === "string") {
-                    return _transform(jids);
-                }
-                return _.map(jids, _transform);
-            },
-            'add': function (jid, name) {
-                if (typeof jid !== "string" || jid.indexOf('@') < 0) {
-                    throw new TypeError('contacts.add: invalid jid');
-                }
-                converse.roster.addAndSubscribe(jid, _.isEmpty(name)? jid: name);
-            }
-        },
-        'chats': {
-            'open': function (jids) {
-                var chatbox;
-                if (typeof jids === "undefined") {
-                    converse.log("chats.open: You need to provide at least one JID", "error");
-                    return null;
-                } else if (typeof jids === "string") {
-                    chatbox = converse.wrappedChatBox(converse.chatboxes.getChatBox(jids, true));
-                    chatbox.open();
-                    return chatbox;
-                }
-                return _.map(jids, function (jid) {
-                    chatbox = converse.wrappedChatBox(converse.chatboxes.getChatBox(jid, true));
-                    chatbox.open();
-                    return chatbox;
-                });
-            },
-            'get': function (jids) {
-                if (typeof jids === "undefined") {
-                    converse.log("chats.get: You need to provide at least one JID", "error");
-                    return null;
-                } else if (typeof jids === "string") {
-                    return converse.wrappedChatBox(converse.chatboxes.getChatBox(jids, true));
-                }
-                return _.map(jids, _.partial(_.compose(converse.wrappedChatBox, converse.chatboxes.getChatBox.bind(converse.chatboxes)), _, true));
-            }
-        },
-        'archive': {
-            'query': function (options, callback, errback) {
-                /* Do a MAM (XEP-0313) query for archived messages.
-                 *
-                 * Parameters:
-                 *    (Object) options - Query parameters, either MAM-specific or also for Result Set Management.
-                 *    (Function) callback - A function to call whenever we receive query-relevant stanza.
-                 *    (Function) errback - A function to call when an error stanza is received.
-                 *
-                 * The options parameter can also be an instance of
-                 * Strophe.RSM to enable easy querying between results pages.
-                 *
-                 * The callback function may be called multiple times, first
-                 * for the initial IQ result and then for each message
-                 * returned. The last time the callback is called, a
-                 * Strophe.RSM object is returned on which "next" or "previous"
-                 * can be called before passing it in again to this method, to
-                 * get the next or previous page in the result set.
-                 */
-                var date, messages = [];
-                if (typeof options === "function") {
-                    callback = options;
-                    errback = callback;
-                }
-                if (!converse.features.findWhere({'var': Strophe.NS.MAM})) {
-                    throw new Error('This server does not support XEP-0313, Message Archive Management');
-                }
-                var queryid = converse.connection.getUniqueId();
-                var attrs = {'type':'set'};
-                if (typeof options !== "undefined" && options.groupchat) {
-                    if (!options['with']) {
-                        throw new Error('You need to specify a "with" value containing the chat room JID, when querying groupchat messages.');
-                    }
-                    attrs.to = options['with'];
-                }
-                var stanza = $iq(attrs).c('query', {'xmlns':Strophe.NS.MAM, 'queryid':queryid});
-                if (typeof options !== "undefined") {
-                    stanza.c('x', {'xmlns':Strophe.NS.XFORM, 'type': 'submit'})
-                            .c('field', {'var':'FORM_TYPE', 'type': 'hidden'})
-                            .c('value').t(Strophe.NS.MAM).up().up();
-
-                    if (options['with'] && !options.groupchat) {
-                        stanza.c('field', {'var':'with'}).c('value').t(options['with']).up().up();
-                    }
-                    _.each(['start', 'end'], function (t) {
-                        if (options[t]) {
-                            date = moment(options[t]);
-                            if (date.isValid()) {
-                                stanza.c('field', {'var':t}).c('value').t(date.format()).up().up();
-                            } else {
-                                throw new TypeError('archive.query: invalid date provided for: '+t);
-                            }
-                        }
-                    });
-                    stanza.up();
-                    if (options instanceof Strophe.RSM) {
-                        stanza.cnode(options.toXML());
-                    } else if (_.intersection(RSM_ATTRIBUTES, _.keys(options)).length) {
-                        stanza.cnode(new Strophe.RSM(options).toXML());
-                    }
-                }
-                converse.connection.addHandler(function (message) {
-                    var $msg = $(message), $fin, rsm;
-                    if (typeof callback === "function") {
-                        $fin = $msg.find('fin[xmlns="'+Strophe.NS.MAM+'"]');
-                        if ($fin.length) {
-                            rsm = new Strophe.RSM({xml: $fin.find('set')[0]});
-                            _.extend(rsm, _.pick(options, ['max']));
-                            _.extend(rsm, _.pick(options, MAM_ATTRIBUTES));
-                            callback(messages, rsm);
-                            return false; // We've received all messages, decommission this handler
-                        } else if (queryid === $msg.find('result').attr('queryid')) {
-                            messages.push(message);
-                        }
-                        return true;
-                    } else {
-                        return false; // There's no callback, so no use in continuing this handler.
-                    }
-                }, Strophe.NS.MAM);
-                converse.connection.sendIQ(stanza, null, errback);
-            }
-        },
-        'tokens': {
-            'get': function (id) {
-                if (!converse.expose_rid_and_sid || typeof converse.connection === "undefined") {
-                    return null;
-                }
-                if (id.toLowerCase() === 'rid') {
-                    return converse.connection.rid || converse.connection._proto.rid;
-                } else if (id.toLowerCase() === 'sid') {
-                    return converse.connection.sid || converse.connection._proto.sid;
-                }
-            }
-        },
-        'listen': {
-            'once': function (evt, handler) {
-                converse.once(evt, handler);
-            },
-            'on': function (evt, handler) {
-                converse.on(evt, handler);
-            },
-            'not': function (evt, handler) {
-                converse.off(evt, handler);
-            },
-        },
-        'send': function (stanza) {
-            converse.connection.send(stanza);
-        },
-        'plugins': {
-            'add': function (name, plugin) {
-                converse.plugins[name] = plugin;
-            },
-            'remove': function (name) {
-                delete converse.plugins[name];
-            },
-            'override': function (name, value) {
-                /* Helper method for overriding methods and attributes directly on the
-                 * converse object. For Backbone objects, use instead the 'extend'
-                 * method.
-                 *
-                 * If a method is overridden, then the original method will still be
-                 * available via the _super attribute.
-                 *
-                 * name: The attribute being overridden.
-                 * value: The value of the attribute being overridden.
-                 */
-                converse._overrideAttribute(name, value);
-            },
-            'extend': function (obj, attributes) {
-                /* Helper method for overriding or extending Converse's Backbone Views or Models
-                 *
-                 * When a method is overriden, the original will still be available
-                 * on the _super attribute of the object being overridden.
-                 *
-                 * obj: The Backbone View or Model
-                 * attributes: A hash of attributes, such as you would pass to Backbone.Model.extend or Backbone.View.extend
-                 */
-                converse._extendObject(obj, attributes);
-            }
-        },
-        'env': {
-            '$build': $build,
-            '$iq': $iq,
-            '$msg': $msg,
-            '$pres': $pres,
-            'Strophe': Strophe,
-            '_': _,
-            'b64_sha1':  b64_sha1,
-            'jQuery': $,
-            'moment': moment
-        }
-    };
-    return API;
+    return converse;
 }));

src/converse-muc.js

@@ -4,43 +4,30 @@
 // Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global converse, utils, Backbone, define, window, setTimeout */
+/*global Backbone, define, window, setTimeout */
 
 /* This is a Converse.js plugin which add support for multi-user chat rooms, as
  * specified in XEP-0045 Multi-user chat.
  */
 (function (root, factory) {
-    if (typeof define === 'function' && define.amd) {
-        // AMD module loading
-        define("converse-muc", ["converse-core", "utils"], factory);
-    } else {
-        // When not using a module loader
-        // -------------------------------
-        // In this case, the dependencies need to be available already as
-        // global variables, and should be loaded separately via *script* tags.
-        // See the file **non_amd.html** for an example of this usecase.
-        factory(converse, utils);
-    }
-}(this, function (converse_api, utils) {
+    define("converse-muc", ["converse-core", "converse-api"], factory);
+}(this, function (converse, converse_api) {
     "use strict";
     // Strophe methods for building stanzas
     var Strophe = converse_api.env.Strophe,
         $iq = converse_api.env.$iq,
+        $build = converse_api.env.$build,
         $msg = converse_api.env.$msg,
         $pres = converse_api.env.$pres,
-        $build = converse_api.env.$build,
-        b64_sha1 = converse_api.env.b64_sha1;
+        b64_sha1 = converse_api.env.b64_sha1,
+        utils = converse_api.env.utils;
     // Other necessary globals
     var $ = converse_api.env.jQuery,
         _ = converse_api.env._,
         moment = converse_api.env.moment;
 
-    // Translation machinery
-    // ---------------------
-    // __ is just a placeholder for now, we need to bind the utils.__ method
-    // to the inner converse object, which we can't here, so we do it in the
-    // initialize method.
-    var __ =  function () {};
+    // For translations
+    var __ = utils.__.bind(converse);
     var ___ = utils.___;
     
     // Add Strophe Namespaces
@@ -199,8 +186,6 @@
              * loaded by converse.js's plugin machinery.
              */
             var converse = this.converse;
-            // For translations
-            __ = utils.__.bind(converse);
             // Configuration values for this plugin
             var settings = {
                 allow_muc: true,

src/converse-otr.js

@@ -4,28 +4,18 @@
 // Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global converse, utils, Backbone, define, window, setTimeout, 
-  crypto, CryptoJS, otr */
+/*global Backbone, define, window, crypto, CryptoJS */
 
 /* This is a Converse.js plugin which add support Off-the-record (OTR)
  * encryption of one-on-one chat messages.
  */
 (function (root, factory) {
-    if (typeof define === 'function' && define.amd) {
-        // AMD module loading
-        define("converse-otr", ["otr", "converse-core", "utils"], factory);
-    } else {
-        // When not using a module loader
-        // -------------------------------
-        // In this case, the dependencies need to be available already as
-        // global variables, and should be loaded separately via *script* tags.
-        // See the file **non_amd.html** for an example of this usecase.
-        factory(otr, converse, utils);
-    }
-}(this, function (otr, converse_api, utils) {
+    define("converse-otr", ["otr", "converse-core", "converse-api"], factory);
+}(this, function (otr, converse, converse_api) {
     "use strict";
     // Strophe methods for building stanzas
     var Strophe = converse_api.env.Strophe,
+        utils = converse_api.env.utils,
         b64_sha1 = converse_api.env.b64_sha1;
     // Other necessary globals
     var $ = converse_api.env.jQuery,
@@ -55,11 +45,7 @@
 
     // Translation aware constants
     // ---------------------------
-
-    // Just a placeholder for now, we need to bind the utils.__ method to the
-    // inner converse object, which we can't here, so we do it in the
-    // initialize method.
-    var __ =  function () {};
+    var __ = utils.__.bind(converse);
 
     var OTR_TRANSLATED_MAPPING  = {};
     OTR_TRANSLATED_MAPPING[UNENCRYPTED] = __('unencrypted');
@@ -190,7 +176,7 @@
                         null,
                         true // show spinner
                     );
-                    setTimeout(function () {
+                    window.setTimeout(function () {
                         var instance_tag = otr.OTR.makeInstanceTag();
                         callback({
                             'key': converse.otr.generatePrivateKey.call(this, instance_tag),

src/converse-ping.js

@@ -4,37 +4,20 @@
 // Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global converse, utils, define */
+/*global define */
 
 /* This is a Converse.js plugin which add support for application-level pings
  * as specified in XEP-0199 XMPP Ping.
  */
 (function (root, factory) {
-    if (typeof define === 'function' && define.amd) {
-        // AMD module loading
-        define("converse-ping", ["converse-core", "utils"], factory);
-    } else {
-        // When not using a module loader
-        // -------------------------------
-        // In this case, the dependencies need to be available already as
-        // global variables, and should be loaded separately via *script* tags.
-        // See the file **non_amd.html** for an example of this usecase.
-        factory(converse, utils);
-    }
-}(this, function (converse_api, utils) {
+    define("converse-ping", ["converse-core", "converse-api"], factory);
+}(this, function (converse, converse_api) {
     "use strict";
     // Strophe methods for building stanzas
     var Strophe = converse_api.env.Strophe;
     // Other necessary globals
     var _ = converse_api.env._;
-
-    // Translation machinery
-    // ---------------------
-    // Just a placeholder for now, we need to bind the utils.__ method to the
-    // inner converse object, which we can't here, so we do it in the
-    // initialize method.
-    var __ =  function () {};
-
+    
     converse_api.plugins.add('ping', {
 
         overrides: {
@@ -61,8 +44,6 @@
              * loaded by converse.js's plugin machinery.
              */
             var converse = this.converse;
-            // For translations
-            __ = utils.__.bind(converse);
             // Configuration values for this plugin
             var settings = {
                 ping_interval: 180 //in seconds

src/converse-register.js

@@ -4,38 +4,24 @@
 // Copyright (c) 2012-2016, Jan-Carel Brand <jc@opkode.com>
 // Licensed under the Mozilla Public License (MPLv2)
 //
-/*global converse, utils, Backbone, define */
+/*global Backbone, define */
 
 /* This is a Converse.js plugin which add support for in-band registration
  * as specified in XEP-0077.
  */
 (function (root, factory) {
-    if (typeof define === 'function' && define.amd) {
-        // AMD module loading
-        define("converse-register", ["converse-core", "utils"], factory);
-    } else {
-        // When not using a module loader
-        // -------------------------------
-        // In this case, the dependencies need to be available already as
-        // global variables, and should be loaded separately via *script* tags.
-        // See the file **non_amd.html** for an example of this usecase.
-        factory(converse, utils);
-    }
-}(this, function (converse_api, utils) {
+    define("converse-register", ["converse-core", "converse-api"], factory);
+}(this, function (converse, converse_api) {
     "use strict";
     // Strophe methods for building stanzas
     var Strophe = converse_api.env.Strophe,
+        utils = converse_api.env.utils,
         $iq = converse_api.env.$iq;
     // Other necessary globals
     var $ = converse_api.env.jQuery,
         _ = converse_api.env._;
-
-    // Translation machinery
-    // ---------------------
-    // Just a placeholder for now, we need to bind the utils.__ method to the
-    // inner converse object, which we can't here, so we do it in the
-    // initialize method.
-    var __ =  function () {};
+    // For translations
+    var __ = utils.__.bind(converse);
     
     // Add Strophe Namespaces
     Strophe.addNamespace('REGISTER', 'jabber:iq:register');

src/utils.js

@@ -90,6 +90,8 @@
         // Translation machinery
         // ---------------------
         __: function (str) {
+            // FIXME: this can be refactored to take the i18n obj as a
+            // parameter.
             // Translation factory
             if (typeof this.i18n === "undefined") {
                 this.i18n = locales.en;