From 576efc4815709aca0645c08f1478b4f5023ae3bc Mon Sep 17 00:00:00 2001 From: JC Brand Date: Tue, 16 Feb 2016 07:46:47 +0000 Subject: [PATCH] Initial work on breaking converse.js up into components First component to remove is MUC which was moved to src/converse-muc.js The components are written as plugins and use converse.js's plugin machinery. Update the plugin docs somewhat with new insites found while working on the muc plugin. --- converse.js | 6734 +---------------------------------- docs/source/development.rst | 20 + main.js | 14 +- src/converse-core.js | 5692 +++++++++++++++++++++++++++++ src/converse-muc.js | 1155 ++++++ 5 files changed, 6891 insertions(+), 6724 deletions(-) mode change 100755 => 100644 converse.js create mode 100755 src/converse-core.js create mode 100644 src/converse-muc.js diff --git a/converse.js b/converse.js old mode 100755 new mode 100644 index 6e893bab1..bf91c9809 --- a/converse.js +++ b/converse.js @@ -1,6721 +1,17 @@ -// Converse.js (A browser based XMPP chat client) -// http://conversejs.org -// -// Copyright (c) 2012-2015, Jan-Carel Brand -// Licensed under the Mozilla Public License (MPLv2) -// -/*global Backbone, CryptoJS, crypto, define, window, jQuery, setTimeout, clearTimeout, document, templates, _, - $iq, $msg, $pres, $build, DSA, OTR, Strophe, moment, utils, b64_sha1, 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 - // - // * **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", - ["converse-dependencies", "converse-templates"], - function (dependencies, templates) { - return factory( - templates, - dependencies.jQuery, - dependencies.$iq, - dependencies.$msg, - dependencies.$pres, - dependencies.$build, - dependencies.otr ? dependencies.otr.DSA : undefined, - dependencies.otr ? dependencies.otr.OTR : undefined, - 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, DSA, OTR, Strophe, _, moment, utils, b64_sha1); - } -}(this, function (templates, $, $iq, $msg, $pres, $build, DSA, OTR, Strophe, _, moment, utils, b64_sha1) { - /* "use strict"; - * Cannot use this due to Safari bug. - * See https://github.com/jcbrand/converse.js/issues/196 +/* Converse.js build configuration + * + * This file is used to tell require.js which components (or plugins) to load + * when it generates a build. + */ +define("converse", [ + /* Removable components + * -------------------- + * Any of the following components can be removed if they're not needed. */ + "converse-muc", // XEP-0045 Multi-user chat + /* End: Removable components */ - // Use Mustache style syntax for variable interpolation - /* Configuration of underscore templates (this config is distinct to the - * config of requirejs-tpl in main.js). This one is for normal inline templates. - */ - _.templateSettings = { - evaluate : /\{\[([\s\S]+?)\]\}/g, - interpolate : /\{\{([\s\S]+?)\}\}/g - }; - - var contains = function (attr, query) { - return function (item) { - if (typeof attr === 'object') { - var value = false; - _.each(attr, function (a) { - value = value || item.get(a).toLowerCase().indexOf(query.toLowerCase()) !== -1; - }); - return value; - } else if (typeof attr === 'string') { - return item.get(attr).toLowerCase().indexOf(query.toLowerCase()) !== -1; - } else { - throw new TypeError('contains: wrong attribute type. Must be string or array.'); - } - }; - }; - contains.not = function (attr, query) { - return function (item) { - return !(contains(attr, query)(item)); - }; - }; - - var converse = { - plugins: {}, - templates: templates, - emit: function (evt, data) { - $(this).trigger(evt, data); - }, - once: function (evt, handler) { - $(this).one(evt, handler); - }, - on: function (evt, handler) { - $(this).bind(evt, handler); - }, - off: function (evt, handler) { - $(this).unbind(evt, handler); - }, - refreshWebkit: function () { - /* This works around a webkit bug. Refresh the browser's viewport, - * otherwise chatboxes are not moved along when one is closed. - */ - if ($.browser.webkit) { - var conversejs = document.getElementById('conversejs'); - conversejs.style.display = 'none'; - conversejs.offsetHeight = conversejs.offsetHeight; - conversejs.style.display = 'block'; - } - } - }; - - // 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 = { - 'offline': 6, - 'unavailable': 5, - 'xa': 4, - 'away': 3, - 'dnd': 2, - 'chat': 1, // We currently don't differentiate between "chat" and "online" - 'online': 1 - }; - - converse.initialize = function (settings, callback) { - "use strict"; - var converse = this; - var unloadevent; - if ('onpagehide' in window) { - // Pagehide gets thrown in more cases than unload. Specifically it - // gets thrown when the page is cached and not just - // closed/destroyed. It's the only viable event on mobile Safari. - // https://www.webkit.org/blog/516/webkit-page-cache-ii-the-unload-event/ - unloadevent = 'pagehide'; - } else if ('onbeforeunload' in window) { - unloadevent = 'beforeunload'; - } else if ('onunload' in window) { - unloadevent = 'unload'; - } - - // Logging - Strophe.log = function (level, msg) { converse.log(level+' '+msg, level); }; - Strophe.error = function (msg) { converse.log(msg, 'error'); }; - - // Add Strophe Namespaces - Strophe.addNamespace('CARBONS', 'urn:xmpp:carbons:2'); - Strophe.addNamespace('CHATSTATES', 'http://jabber.org/protocol/chatstates'); - Strophe.addNamespace('CSI', 'urn:xmpp:csi:0'); - Strophe.addNamespace('MAM', 'urn:xmpp:mam:0'); - Strophe.addNamespace('MUC_ADMIN', Strophe.NS.MUC + "#admin"); - Strophe.addNamespace('MUC_OWNER', Strophe.NS.MUC + "#owner"); - Strophe.addNamespace('MUC_REGISTER', "jabber:iq:register"); - Strophe.addNamespace('MUC_ROOMCONF', Strophe.NS.MUC + "#roomconfig"); - Strophe.addNamespace('MUC_USER', Strophe.NS.MUC + "#user"); - Strophe.addNamespace('REGISTER', 'jabber:iq:register'); - Strophe.addNamespace('ROSTERX', 'http://jabber.org/protocol/rosterx'); - Strophe.addNamespace('RSM', 'http://jabber.org/protocol/rsm'); - Strophe.addNamespace('XFORM', 'jabber:x:data'); - - // Add Strophe Statuses - var i = 0; - Object.keys(Strophe.Status).forEach(function (key) { - i = Math.max(i, Strophe.Status[key]); - }); - Strophe.Status.REGIFAIL = i + 1; - Strophe.Status.REGISTERED = i + 2; - Strophe.Status.CONFLICT = i + 3; - Strophe.Status.NOTACCEPTABLE = i + 5; - - // Constants - // --------- - var LOGIN = "login"; - var ANONYMOUS = "anonymous"; - var PREBIND = "prebind"; - - var UNENCRYPTED = 0; - var UNVERIFIED= 1; - var VERIFIED= 2; - var FINISHED = 3; - var KEY = { - ENTER: 13, - FORWARD_SLASH: 47 - }; - - var PRETTY_CONNECTION_STATUS = { - 0: 'ERROR', - 1: 'CONNECTING', - 2: 'CONNFAIL', - 3: 'AUTHENTICATING', - 4: 'AUTHFAIL', - 5: 'CONNECTED', - 6: 'DISCONNECTED', - 7: 'DISCONNECTING', - 8: 'ATTACHED', - 9: 'REDIRECT' - }; - - // XEP-0085 Chat states - // http://xmpp.org/extensions/xep-0085.html - var INACTIVE = 'inactive'; - var ACTIVE = 'active'; - var COMPOSING = 'composing'; - var PAUSED = 'paused'; - var GONE = 'gone'; - this.TIMEOUTS = { // Set as module attr so that we can override in tests. - 'PAUSED': 20000, - 'INACTIVE': 90000 - }; - var HAS_CSPRNG = ((typeof crypto !== 'undefined') && - ((typeof crypto.randomBytes === 'function') || - (typeof crypto.getRandomValues === 'function') - )); - var HAS_CRYPTO = HAS_CSPRNG && ( - (typeof CryptoJS !== "undefined") && - (typeof OTR !== "undefined") && - (typeof DSA !== "undefined") - ); - var OPENED = 'opened'; - var CLOSED = 'closed'; - - // Detect support for the user's locale - // ------------------------------------ - this.isConverseLocale = function (locale) { return typeof locales[locale] !== "undefined"; }; - this.isMomentLocale = function (locale) { return moment.locale() !== moment.locale(locale); }; - - this.isLocaleAvailable = function (locale, available) { - /* Check whether the locale or sub locale (e.g. en-US, en) is supported. - * - * Parameters: - * (Function) available - returns a boolean indicating whether the locale is supported - */ - if (available(locale)) { - return locale; - } else { - var sublocale = locale.split("-")[0]; - if (sublocale !== locale && available(sublocale)) { - return sublocale; - } - } - }; - - this.detectLocale = function (library_check) { - /* Determine which locale is supported by the user's system as well - * as by the relevant library (e.g. converse.js or moment.js). - * - * Parameters: - * (Function) library_check - returns a boolean indicating whether the locale is supported - */ - var locale, i; - if (window.navigator.userLanguage) { - locale = this.isLocaleAvailable(window.navigator.userLanguage, library_check); - } - if (window.navigator.languages && !locale) { - for (i=0; i 0) { - this.idle_seconds = 0; - } - if (!converse.connection.authenticated) { - // We can't send out any stanzas when there's no authenticated connection. - // This can happen when the connection reconnects. - return; - } - if (this.inactive) { - this.sendCSI(ACTIVE); - } - if (this.auto_changed_status === true) { - this.auto_changed_status = false; - this.xmppstatus.setStatus('online'); - } - }; - - this.onEverySecond = function () { - /* An interval handler running every second. - * Used for CSI and the auto_away and auto_xa - * features. - */ - if (!converse.connection.authenticated) { - // We can't send out any stanzas when there's no authenticated connection. - // This can happen when the connection reconnects. - return; - } - var stat = this.xmppstatus.getStatus(); - this.idle_seconds++; - if (this.csi_waiting_time > 0 && this.idle_seconds > this.csi_waiting_time && !this.inactive) { - this.sendCSI(INACTIVE); - } - if (this.auto_away > 0 && this.idle_seconds > this.auto_away && stat !== 'away' && stat !== 'xa') { - this.auto_changed_status = true; - this.xmppstatus.setStatus('away'); - } else if (this.auto_xa > 0 && this.idle_seconds > this.auto_xa && stat !== 'xa') { - this.auto_changed_status = true; - this.xmppstatus.setStatus('xa'); - } - }; - - this.registerIntervalHandler = function () { - /* Set an interval of one second and register a handler for it. - * Required for the auto_away, auto_xa and csi_waiting_time features. - */ - if (this.auto_away < 1 && this.auto_xa < 1 && this.csi_waiting_time < 1) { - // Waiting time of less then one second means features aren't used. - return; - } - this.idle_seconds = 0; - this.auto_changed_status = false; // Was the user's status changed by converse.js? - $(window).on('click mousemove keypress focus'+unloadevent , this.onUserActivity.bind(this)); - window.setInterval(this.onEverySecond.bind(this), 1000); - }; - - this.playNotification = function () { - var audio; - if (converse.play_sounds && typeof Audio !== "undefined") { - audio = new Audio(converse.sounds_path+"msg_received.ogg"); - if (audio.canPlayType('/audio/ogg')) { - audio.play(); - } else { - audio = new Audio(converse.sounds_path+"msg_received.mp3"); - audio.play(); - } - } - }; - - this.giveFeedback = function (message, klass) { - $('.conn-feedback').each(function (idx, el) { - var $el = $(el); - $el.addClass('conn-feedback').text(message); - if (klass) { - $el.addClass(klass); - } else { - $el.removeClass('error'); - } - }); - }; - - this.log = function (txt, level) { - var logger; - if (typeof console === "undefined" || typeof console.log === "undefined") { - logger = { log: function () {}, error: function () {} }; - } else { - logger = console; - } - if (this.debug) { - if (level === 'error') { - logger.log('ERROR: '+txt); - } else { - logger.log(txt); - } - } - }; - - this.rejectPresenceSubscription = function (jid, message) { - /* Reject or cancel another user's subscription to our presence updates. - * Parameters: - * (String) jid - The Jabber ID of the user whose subscription - * is being canceled. - * (String) message - An optional message to the user - */ - var pres = $pres({to: jid, type: "unsubscribed"}); - if (message && message !== "") { pres.c("status").t(message); } - converse.connection.send(pres); - }; - - this.getVCard = function (jid, callback, errback) { - /* Request the VCard of another user. - * - * Parameters: - * (String) jid - The Jabber ID of the user whose VCard is being requested. - * (Function) callback - A function to call once the VCard is returned - * (Function) errback - A function to call if an error occured - * while trying to fetch the VCard. - */ - if (!this.use_vcards) { - if (callback) { callback(jid, jid); } - return; - } - converse.connection.vcard.get( - function (iq) { // Successful callback - var $vcard = $(iq).find('vCard'); - var fullname = $vcard.find('FN').text(), - img = $vcard.find('BINVAL').text(), - img_type = $vcard.find('TYPE').text(), - url = $vcard.find('URL').text(); - if (jid) { - var contact = converse.roster.get(jid); - if (contact) { - fullname = _.isEmpty(fullname)? contact.get('fullname') || jid: fullname; - contact.save({ - 'fullname': fullname, - 'image_type': img_type, - 'image': img, - 'url': url, - 'vcard_updated': moment().format() - }); - } - } - if (callback) { callback(iq, jid, fullname, img, img_type, url); } - }.bind(this), - jid, - function (iq) { // Error callback - var contact = converse.roster.get(jid); - if (contact) { - contact.save({ 'vcard_updated': moment().format() }); - } - if (errback) { errback(iq, jid); } - } - ); - }; - - 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 () { - if (converse.authentication !== "prebind") { - this.connection.connect( - this.connection.jid, - this.connection.pass, - function (status, condition) { - this.onConnectStatusChanged(status, condition, true); - }.bind(this), - this.connection.wait, - this.connection.hold, - this.connection.route - ); - } else if (converse.prebind_url) { - this.clearSession(); - this._tearDown(); - this.startNewBOSHSession(); - } - }.bind(this), 5000); - }; - - this.renderLoginPanel = function () { - converse._tearDown(); - var view = converse.chatboxviews.get('controlbox'); - view.model.set({connected:false}); - view.renderLoginPanel(); - }; - - this.onConnectStatusChanged = function (status, condition, reconnect) { - converse.log("Status changed to: "+PRETTY_CONNECTION_STATUS[status]); - if (status === Strophe.Status.CONNECTED || status === Strophe.Status.ATTACHED) { - // By default we always want to send out an initial presence stanza. - converse.send_initial_presence = true; - delete converse.disconnection_cause; - if (!!converse.reconnectTimeout) { - clearTimeout(converse.reconnectTimeout); - delete converse.reconnectTimeout; - } - if ((typeof reconnect !== 'undefined') && (reconnect)) { - converse.log(status === Strophe.Status.CONNECTED ? 'Reconnected' : 'Reattached'); - converse.onReconnected(); - } else { - converse.log(status === Strophe.Status.CONNECTED ? 'Connected' : 'Attached'); - if (converse.connection.restored) { - converse.send_initial_presence = false; // No need to send an initial presence stanza when - // we're restoring an existing session. - } - converse.onConnected(); - } - } else if (status === Strophe.Status.DISCONNECTED) { - if (converse.disconnection_cause === Strophe.Status.CONNFAIL && converse.auto_reconnect) { - converse.reconnect(condition); - } else { - converse.renderLoginPanel(); - } - } else if (status === Strophe.Status.ERROR) { - converse.giveFeedback(__('Error'), 'error'); - } else if (status === Strophe.Status.CONNECTING) { - converse.giveFeedback(__('Connecting')); - } else if (status === Strophe.Status.AUTHENTICATING) { - converse.giveFeedback(__('Authenticating')); - } else if (status === Strophe.Status.AUTHFAIL) { - converse.giveFeedback(__('Authentication Failed'), 'error'); - converse.connection.disconnect(__('Authentication Failed')); - converse.disconnection_cause = Strophe.Status.AUTHFAIL; - } else if (status === Strophe.Status.CONNFAIL) { - converse.disconnection_cause = Strophe.Status.CONNFAIL; - } else if (status === Strophe.Status.DISCONNECTING) { - // FIXME: what about prebind? - if (!converse.connection.connected) { - converse.renderLoginPanel(); - } - if (condition) { - converse.giveFeedback(condition, 'error'); - } - } - }; - - this.applyDragResistance = function (value, default_value) { - /* This method applies some resistance around the - * default_value. If value is close enough to - * default_value, then default_value is returned instead. - */ - if (typeof value === 'undefined') { - return undefined; - } else if (typeof default_value === 'undefined') { - return value; - } - var resistance = 10; - if ((value !== default_value) && - (Math.abs(value- default_value) < resistance)) { - return default_value; - } - return value; - }; - - this.updateMsgCounter = function () { - if (this.msg_counter > 0) { - if (document.title.search(/^Messages \(\d+\) /) === -1) { - document.title = "Messages (" + this.msg_counter + ") " + document.title; - } else { - document.title = document.title.replace(/^Messages \(\d+\) /, "Messages (" + this.msg_counter + ") "); - } - window.blur(); - window.focus(); - } else if (document.title.search(/^Messages \(\d+\) /) !== -1) { - document.title = document.title.replace(/^Messages \(\d+\) /, ""); - } - }; - - this.incrementMsgCounter = function () { - this.msg_counter += 1; - this.updateMsgCounter(); - }; - - this.clearMsgCounter = function () { - this.msg_counter = 0; - this.updateMsgCounter(); - }; - - this.initStatus = function (callback) { - this.xmppstatus = new this.XMPPStatus(); - var id = b64_sha1('converse.xmppstatus-'+converse.bare_jid); - this.xmppstatus.id = id; // Appears to be necessary for backbone.browserStorage - this.xmppstatus.browserStorage = new Backbone.BrowserStorage[converse.storage](id); - this.xmppstatus.fetch({success: callback, error: callback}); - }; - - this.initSession = function () { - this.session = new this.Session(); - var id = b64_sha1('converse.bosh-session'); - this.session.id = id; // Appears to be necessary for backbone.browserStorage - this.session.browserStorage = new Backbone.BrowserStorage[converse.storage](id); - this.session.fetch(); - }; - - this.clearSession = function () { - if (this.roster) { - this.roster.browserStorage._clear(); - } - this.session.browserStorage._clear(); - if (converse.connection.connected) { - converse.chatboxes.get('controlbox').save({'connected': false}); - } - }; - - this.logOut = function () { - converse.auto_login = false; - converse.chatboxviews.closeAllChatBoxes(false); - converse.clearSession(); - converse.connection.disconnect(); - }; - - this.registerGlobalEventHandlers = function () { - $(document).click(function () { - if ($('.toggle-otr ul').is(':visible')) { - $('.toggle-otr ul', this).slideUp(); - } - if ($('.toggle-smiley ul').is(':visible')) { - $('.toggle-smiley ul', this).slideUp(); - } - }); - - $(document).on('mousemove', function (ev) { - if (!this.resizing || !this.allow_dragresize) { return true; } - ev.preventDefault(); - this.resizing.chatbox.resizeChatBox(ev); - }.bind(this)); - - $(document).on('mouseup', function (ev) { - if (!this.resizing || !this.allow_dragresize) { return true; } - ev.preventDefault(); - var height = this.applyDragResistance( - this.resizing.chatbox.height, - this.resizing.chatbox.model.get('default_height') - ); - var width = this.applyDragResistance( - this.resizing.chatbox.width, - this.resizing.chatbox.model.get('default_width') - ); - if (this.connection.connected) { - this.resizing.chatbox.model.save({'height': height}); - this.resizing.chatbox.model.save({'width': width}); - } else { - this.resizing.chatbox.model.set({'height': height}); - this.resizing.chatbox.model.set({'width': width}); - } - this.resizing = null; - }.bind(this)); - - $(window).on("blur focus", function (ev) { - if ((this.windowState !== ev.type) && (ev.type === 'focus')) { - converse.clearMsgCounter(); - } - this.windowState = ev.type; - }.bind(this)); - - $(window).on("resize", _.debounce(function (ev) { - this.chatboxviews.trimChats(); - }.bind(this), 200)); - }; - - this.ping = function (jid, success, error, timeout) { - // XXX: We could first check here if the server advertised that it supports PING. - // However, some servers don't advertise while still keeping the - // connection option due to pings. - // - // var feature = converse.features.findWhere({'var': Strophe.NS.PING}); - converse.lastStanzaDate = new Date(); - if (typeof jid === 'undefined' || jid === null) { - jid = Strophe.getDomainFromJid(converse.bare_jid); - } - if (typeof timeout === 'undefined' ) { timeout = null; } - if (typeof success === 'undefined' ) { success = null; } - if (typeof error === 'undefined' ) { error = null; } - if (converse.connection) { - converse.connection.ping.ping(jid, success, error, timeout); - return true; - } - return false; - }; - - this.pong = function (ping) { - converse.lastStanzaDate = new Date(); - converse.connection.ping.pong(ping); - return true; - }; - - this.registerPongHandler = function () { - converse.connection.disco.addFeature(Strophe.NS.PING); - converse.connection.ping.addPingHandler(this.pong); - }; - - this.registerPingHandler = function () { - this.registerPongHandler(); - if (this.ping_interval > 0) { - this.connection.addHandler(function () { - /* Handler on each stanza, saves the received date - * in order to ping only when needed. - */ - this.lastStanzaDate = new Date(); - return true; - }.bind(converse)); - this.connection.addTimedHandler(1000, function () { - var now = new Date(); - if (!this.lastStanzaDate) { - this.lastStanzaDate = now; - } - if ((now - this.lastStanzaDate)/1000 > this.ping_interval) { - return this.ping(); - } - return true; - }.bind(converse)); - } - }; - - this.onReconnected = function () { - // We need to re-register all the event handlers on the newly - // created connection. - this.initStatus(function () { - this.registerPingHandler(); - this.rosterview.registerRosterXHandler(); - this.rosterview.registerPresenceHandler(); - this.chatboxes.registerMessageHandler(); - this.xmppstatus.sendPresence(); - this.giveFeedback(__('Contacts')); - }.bind(this)); - }; - - this.enableCarbons = function () { - /* Ask the XMPP server to enable Message Carbons - * See XEP-0280 https://xmpp.org/extensions/xep-0280.html#enabling - */ - if (!this.message_carbons || this.session.get('carbons_enabled')) { - return; - } - var carbons_iq = new Strophe.Builder('iq', { - from: this.connection.jid, - id: 'enablecarbons', - type: 'set' - }) - .c('enable', {xmlns: Strophe.NS.CARBONS}); - this.connection.addHandler(function (iq) { - if ($(iq).find('error').length > 0) { - converse.log('ERROR: An error occured while trying to enable message carbons.'); - } else { - this.session.save({carbons_enabled: true}); - converse.log('Message carbons have been enabled.'); - } - }.bind(this), null, "iq", null, "enablecarbons"); - this.connection.send(carbons_iq); - }; - - this.onConnected = function () { - // When reconnecting, there might be some open chat boxes. We don't - // know whether these boxes are of the same account or not, so we - // close them now. - this.chatboxviews.closeAllChatBoxes(); - this.jid = this.connection.jid; - this.bare_jid = Strophe.getBareJidFromJid(this.connection.jid); - this.resource = Strophe.getResourceFromJid(this.connection.jid); - this.domain = Strophe.getDomainFromJid(this.connection.jid); - this.minimized_chats = new converse.MinimizedChats({model: this.chatboxes}); - this.features = new this.Features(); - this.enableCarbons(); - this.initStatus(function () { - this.registerPingHandler(); - this.registerIntervalHandler(); - this.chatboxes.onConnected(); - this.giveFeedback(__('Contacts')); - if (this.callback) { - if (this.connection.service === 'jasmine tests') { - // XXX: Call back with the internal converse object. This - // object should never be exposed to production systems. - // 'jasmine tests' is an invalid http bind service value, - // so we're sure that this is just for tests. - this.callback(this); - } else { - this.callback(); - } - } - }.bind(this)); - converse.emit('ready'); - }; - - // Backbone Models and Views - // ------------------------- - this.OTR = Backbone.Model.extend({ - // A model for managing OTR settings. - getSessionPassphrase: function () { - if (converse.authentication === 'prebind') { - var key = b64_sha1(converse.connection.jid), - pass = window.sessionStorage[key]; - if (typeof pass === 'undefined') { - pass = Math.floor(Math.random()*4294967295).toString(); - window.sessionStorage[key] = pass; - } - return pass; - } else { - return converse.connection.pass; - } - }, - - generatePrivateKey: function (instance_tag) { - var key = new DSA(); - var jid = converse.connection.jid; - if (converse.cache_otr_key) { - var cipher = CryptoJS.lib.PasswordBasedCipher; - var pass = this.getSessionPassphrase(); - if (typeof pass !== "undefined") { - // Encrypt the key and set in sessionStorage. Also store instance tag. - window.sessionStorage[b64_sha1(jid+'priv_key')] = - cipher.encrypt(CryptoJS.algo.AES, key.packPrivate(), pass).toString(); - window.sessionStorage[b64_sha1(jid+'instance_tag')] = instance_tag; - window.sessionStorage[b64_sha1(jid+'pass_check')] = - cipher.encrypt(CryptoJS.algo.AES, 'match', pass).toString(); - } - } - return key; - } - }); - - this.Message = Backbone.Model.extend({ - idAttribute: 'msgid', - defaults: function(){ - return { - msgid: converse.connection.getUniqueId() - }; - } - }); - this.Messages = Backbone.Collection.extend({ - model: converse.Message, - comparator: 'time' - }); - - this.ChatBox = Backbone.Model.extend({ - - initialize: function () { - var height = this.get('height'), - width = this.get('width'), - settings = { - 'height': converse.applyDragResistance(height, this.get('default_height')), - 'width': converse.applyDragResistance(width, this.get('default_width')), - 'num_unread': this.get('num_unread') || 0 - }; - if (this.get('box_id') !== 'controlbox') { - this.messages = new converse.Messages(); - this.messages.browserStorage = new Backbone.BrowserStorage[converse.storage]( - b64_sha1('converse.messages'+this.get('jid')+converse.bare_jid)); - this.save(_.extend(settings, { - // The chat_state will be set to ACTIVE once the chat box is opened - // and we listen for change:chat_state, so shouldn't set it to ACTIVE here. - 'chat_state': undefined, - 'box_id' : b64_sha1(this.get('jid')), - 'minimized': this.get('minimized') || false, - 'otr_status': this.get('otr_status') || UNENCRYPTED, - 'time_minimized': this.get('time_minimized') || moment(), - 'time_opened': this.get('time_opened') || moment().valueOf(), - 'url': '', - 'user_id' : Strophe.getNodeFromJid(this.get('jid')) - })); - } else { - this.set(_.extend(settings, { 'time_opened': moment(0).valueOf() })); - } - }, - - maximize: function () { - this.save({ - 'minimized': false, - 'time_opened': moment().valueOf() - }); - }, - - minimize: function () { - this.save({ - 'minimized': true, - 'time_minimized': moment().format() - }); - }, - - getSession: function (callback) { - var cipher = CryptoJS.lib.PasswordBasedCipher; - var pass, instance_tag, saved_key, pass_check; - if (converse.cache_otr_key) { - pass = converse.otr.getSessionPassphrase(); - if (typeof pass !== "undefined") { - instance_tag = window.sessionStorage[b64_sha1(this.id+'instance_tag')]; - saved_key = window.sessionStorage[b64_sha1(this.id+'priv_key')]; - pass_check = window.sessionStorage[b64_sha1(this.connection.jid+'pass_check')]; - if (saved_key && instance_tag && typeof pass_check !== 'undefined') { - var decrypted = cipher.decrypt(CryptoJS.algo.AES, saved_key, pass); - var key = DSA.parsePrivate(decrypted.toString(CryptoJS.enc.Latin1)); - if (cipher.decrypt(CryptoJS.algo.AES, pass_check, pass).toString(CryptoJS.enc.Latin1) === 'match') { - // Verified that the passphrase is still the same - this.trigger('showHelpMessages', [__('Re-establishing encrypted session')]); - callback({ - 'key': key, - 'instance_tag': instance_tag - }); - return; // Our work is done here - } - } - } - } - // We need to generate a new key and instance tag - this.trigger('showHelpMessages', [ - __('Generating private key.'), - __('Your browser might become unresponsive.')], - null, - true // show spinner - ); - setTimeout(function () { - var instance_tag = OTR.makeInstanceTag(); - callback({ - 'key': converse.otr.generatePrivateKey.call(this, instance_tag), - 'instance_tag': instance_tag - }); - }, 500); - }, - - updateOTRStatus: function (state) { - switch (state) { - case OTR.CONST.STATUS_AKE_SUCCESS: - if (this.otr.msgstate === OTR.CONST.MSGSTATE_ENCRYPTED) { - this.save({'otr_status': UNVERIFIED}); - } - break; - case OTR.CONST.STATUS_END_OTR: - if (this.otr.msgstate === OTR.CONST.MSGSTATE_FINISHED) { - this.save({'otr_status': FINISHED}); - } else if (this.otr.msgstate === OTR.CONST.MSGSTATE_PLAINTEXT) { - this.save({'otr_status': UNENCRYPTED}); - } - break; - } - }, - - onSMP: function (type, data) { - // Event handler for SMP (Socialist's Millionaire Protocol) - // used by OTR (off-the-record). - switch (type) { - case 'question': - this.otr.smpSecret(prompt(__( - 'Authentication request from %1$s\n\nYour chat contact is attempting to verify your identity, by asking you the question below.\n\n%2$s', - [this.get('fullname'), data]))); - break; - case 'trust': - if (data === true) { - this.save({'otr_status': VERIFIED}); - } else { - this.trigger( - 'showHelpMessages', - [__("Could not verify this user's identify.")], - 'error'); - this.save({'otr_status': UNVERIFIED}); - } - break; - default: - throw new TypeError('ChatBox.onSMP: Unknown type for SMP'); - } - }, - - initiateOTR: function (query_msg) { - // Sets up an OTR object through which we can send and receive - // encrypted messages. - // - // If 'query_msg' is passed in, it means there is an alread incoming - // query message from our contact. Otherwise, it is us who will - // send the query message to them. - this.save({'otr_status': UNENCRYPTED}); - this.getSession(function (session) { - this.otr = new OTR({ - fragment_size: 140, - send_interval: 200, - priv: session.key, - instance_tag: session.instance_tag, - debug: this.debug - }); - this.otr.on('status', this.updateOTRStatus.bind(this)); - this.otr.on('smp', this.onSMP.bind(this)); - - this.otr.on('ui', function (msg) { - this.trigger('showReceivedOTRMessage', msg); - }.bind(this)); - this.otr.on('io', function (msg) { - this.trigger('sendMessage', new converse.Message({ message: msg })); - }.bind(this)); - this.otr.on('error', function (msg) { - this.trigger('showOTRError', msg); - }.bind(this)); - - this.trigger('showHelpMessages', [__('Exchanging private key with contact.')]); - if (query_msg) { - this.otr.receiveMsg(query_msg); - } else { - this.otr.sendQueryMsg(); - } - }.bind(this)); - }, - - endOTR: function () { - if (this.otr) { - this.otr.endOtr(); - } - this.save({'otr_status': UNENCRYPTED}); - }, - - createMessage: function ($message, $delay, archive_id) { - $delay = $delay || $message.find('delay'); - var body = $message.children('body').text(), - delayed = $delay.length > 0, - fullname = this.get('fullname'), - is_groupchat = $message.attr('type') === 'groupchat', - msgid = $message.attr('id'), - chat_state = $message.find(COMPOSING).length && COMPOSING || - $message.find(PAUSED).length && PAUSED || - $message.find(INACTIVE).length && INACTIVE || - $message.find(ACTIVE).length && ACTIVE || - $message.find(GONE).length && GONE, - stamp, time, sender, from; - - if (is_groupchat) { - from = Strophe.unescapeNode(Strophe.getResourceFromJid($message.attr('from'))); - } else { - from = Strophe.getBareJidFromJid($message.attr('from')); - } - fullname = (_.isEmpty(fullname) ? from: fullname).split(' ')[0]; - if (delayed) { - stamp = $delay.attr('stamp'); - time = stamp; - } else { - time = moment().format(); - } - if ((is_groupchat && from === this.get('nick')) || (!is_groupchat && from === converse.bare_jid)) { - sender = 'me'; - } else { - sender = 'them'; - } - this.messages.create({ - chat_state: chat_state, - delayed: delayed, - fullname: fullname, - message: body || undefined, - msgid: msgid, - sender: sender, - time: time, - archive_id: archive_id - }); - }, - - receiveMessage: function ($message, $delay, archive_id) { - var $body = $message.children('body'); - var text = ($body.length > 0 ? $body.text() : undefined); - if ((!text) || (!converse.allow_otr)) { - return this.createMessage($message, $delay, archive_id); - } - if (text.match(/^\?OTRv23?/)) { - this.initiateOTR(text); - } else { - if (_.contains([UNVERIFIED, VERIFIED], this.get('otr_status'))) { - this.otr.receiveMsg(text); - } else { - if (text.match(/^\?OTR/)) { - if (!this.otr) { - this.initiateOTR(text); - } else { - this.otr.receiveMsg(text); - } - } else { - // Normal unencrypted message. - this.createMessage($message, $delay, archive_id); - } - } - } - } - }); - - this.ChatBoxView = Backbone.View.extend({ - length: 200, - tagName: 'div', - className: 'chatbox', - is_chatroom: false, // This is not a multi-user chatroom - - events: { - 'click .close-chatbox-button': 'close', - 'click .toggle-chatbox-button': 'minimize', - 'keypress textarea.chat-textarea': 'keyPressed', - 'click .toggle-smiley': 'toggleEmoticonMenu', - 'click .toggle-smiley ul li': 'insertEmoticon', - 'click .toggle-clear': 'clearMessages', - 'click .toggle-otr': 'toggleOTRMenu', - 'click .start-otr': 'startOTRFromToolbar', - 'click .end-otr': 'endOTR', - 'click .auth-otr': 'authOTR', - 'click .toggle-call': 'toggleCall', - 'mousedown .dragresize-top': 'onStartVerticalResize', - 'mousedown .dragresize-left': 'onStartHorizontalResize', - 'mousedown .dragresize-topleft': 'onStartDiagonalResize' - }, - - initialize: function () { - $(window).on('resize', _.debounce(this.setDimensions.bind(this), 100)); - this.model.messages.on('add', this.onMessageAdded, this); - this.model.on('show', this.show, this); - this.model.on('destroy', this.hide, this); - // TODO check for changed fullname as well - this.model.on('change:chat_state', this.sendChatState, this); - this.model.on('change:chat_status', this.onChatStatusChanged, this); - this.model.on('change:image', this.renderAvatar, this); - this.model.on('change:otr_status', this.onOTRStatusChanged, this); - this.model.on('change:minimized', this.onMinimizedChanged, this); - this.model.on('change:status', this.onStatusChanged, this); - this.model.on('showOTRError', this.showOTRError, this); - this.model.on('showHelpMessages', this.showHelpMessages, this); - this.model.on('sendMessage', this.sendMessage, this); - this.model.on('showSentOTRMessage', function (text) { - this.showMessage({'message': text, 'sender': 'me'}); - }, this); - this.model.on('showReceivedOTRMessage', function (text) { - this.showMessage({'message': text, 'sender': 'them'}); - }, this); - this.updateVCard().render().fetchMessages().insertIntoPage().hide(); - - if ((_.contains([UNVERIFIED, VERIFIED], this.model.get('otr_status'))) || converse.use_otr_by_default) { - this.model.initiateOTR(); - } - }, - - render: function () { - this.$el.attr('id', this.model.get('box_id')) - .html(converse.templates.chatbox( - _.extend(this.model.toJSON(), { - show_toolbar: converse.show_toolbar, - info_close: __('Close this chat box'), - info_minimize: __('Minimize this chat box'), - info_view: __('View more information on this person'), - label_personal_message: __('Personal message') - } - ) - ) - ); - this.setWidth(); - this.$content = this.$el.find('.chat-content'); - this.renderToolbar().renderAvatar(); - this.$content.on('scroll', _.debounce(this.onScroll.bind(this), 100)); - converse.emit('chatBoxOpened', this); - setTimeout(converse.refreshWebkit, 50); - return this.showStatusMessage(); - }, - - setWidth: function () { - // If a custom width is applied (due to drag-resizing), - // then we need to set the width of the .chatbox element as well. - if (this.model.get('width')) { - this.$el.css('width', this.model.get('width')); - } - }, - - onScroll: function (ev) { - if ($(ev.target).scrollTop() === 0 && this.model.messages.length) { - this.fetchArchivedMessages({ - 'before': this.model.messages.at(0).get('archive_id'), - 'with': this.model.get('jid'), - 'max': converse.archived_messages_page_size - }); - } - }, - - fetchMessages: function () { - /* Responsible for fetching previously sent messages, first - * from session storage, and then once that's done by calling - * fetchArchivedMessages, which fetches from the XMPP server if - * applicable. - */ - this.model.messages.fetch({ - 'add': true, - 'success': function () { - if (!converse.features.findWhere({'var': Strophe.NS.MAM})) { - return; - } - if (this.model.messages.length < converse.archived_messages_page_size) { - this.fetchArchivedMessages({ - 'before': '', // Page backwards from the most recent message - 'with': this.model.get('jid'), - 'max': converse.archived_messages_page_size - }); - } - }.bind(this) - }); - return this; - }, - - fetchArchivedMessages: function (options) { - /* Fetch archived chat messages from the XMPP server. - * - * Then, upon receiving them, call onMessage on the chat box, - * so that they are displayed inside it. - */ - if (!converse.features.findWhere({'var': Strophe.NS.MAM})) { - converse.log("Attempted to fetch archived messages but this user's server doesn't support XEP-0313"); - return; - } - this.addSpinner(); - API.archive.query(_.extend(options, {'groupchat': this.is_chatroom}), - function (messages) { - this.clearSpinner(); - if (messages.length) { - if (this.is_chatroom) { - _.map(messages, this.onChatRoomMessage.bind(this)); - } else { - _.map(messages, converse.chatboxes.onMessage.bind(converse.chatboxes)); - } - } - }.bind(this), - function () { - this.clearSpinner(); - converse.log("Error while trying to fetch archived messages", "error"); - }.bind(this) - ); - }, - - insertIntoPage: function () { - this.$el.insertAfter(converse.chatboxviews.get("controlbox").$el); - return this; - }, - - adjustToViewport: function () { - /* Event handler called when viewport gets resized. We remove - * custom width/height from chat boxes. - */ - var viewport_width = Math.max(document.documentElement.clientWidth, window.innerWidth || 0); - var viewport_height = Math.max(document.documentElement.clientHeight, window.innerHeight || 0); - if (viewport_width <= 480) { - this.model.set('height', undefined); - this.model.set('width', undefined); - } else if (viewport_width <= this.model.get('width')) { - this.model.set('width', undefined); - } else if (viewport_height <= this.model.get('height')) { - this.model.set('height', undefined); - } - }, - - initDragResize: function () { - /* Determine and store the default box size. - * We need this information for the drag-resizing feature. - */ - var $flyout = this.$el.find('.box-flyout'); - if (typeof this.model.get('height') === 'undefined') { - var height = $flyout.height(); - var width = $flyout.width(); - this.model.set('height', height); - this.model.set('default_height', height); - this.model.set('width', width); - this.model.set('default_width', width); - } - var min_width = $flyout.css('min-width'); - var min_height = $flyout.css('min-height'); - this.model.set('min_width', min_width.endsWith('px') ? Number(min_width.replace(/px$/, '')) :0); - this.model.set('min_height', min_height.endsWith('px') ? Number(min_height.replace(/px$/, '')) :0); - // Initialize last known mouse position - this.prev_pageY = 0; - this.prev_pageX = 0; - if (converse.connection.connected) { - this.height = this.model.get('height'); - this.width = this.model.get('width'); - } - return this; - }, - - setDimensions: function () { - // Make sure the chat box has the right height and width. - this.adjustToViewport(); - this.setChatBoxHeight(this.model.get('height')); - this.setChatBoxWidth(this.model.get('width')); - }, - - clearStatusNotification: function () { - this.$content.find('div.chat-event').remove(); - }, - - showStatusNotification: function (message, keep_old) { - if (!keep_old) { - this.clearStatusNotification(); - } - var was_at_bottom = this.$content.scrollTop() + this.$content.innerHeight() >= this.$content[0].scrollHeight; - this.$content.append($('
').text(message)); - if (was_at_bottom) { - this.scrollDown(); - } - }, - - clearChatRoomMessages: function (ev) { - if (typeof ev !== "undefined") { ev.stopPropagation(); } - var result = confirm(__("Are you sure you want to clear the messages from this room?")); - if (result === true) { - this.$content.empty(); - } - return this; - }, - - addSpinner: function () { - if (!this.$content.first().hasClass('spinner')) { - this.$content.prepend('