// Converse.js (A browser based XMPP chat client) // http://conversejs.org // // Copyright (c) 2012-2017, Jan-Carel Brand // Licensed under the Mozilla Public License (MPLv2) // /*global define */ /* This is a Converse.js plugin which add support for in-band registration * as specified in XEP-0077. */ (function (root, factory) { define(["utils/form", "converse-core", "templates/form_username.html", "templates/register_link.html", "templates/register_panel.html", "templates/registration_form.html", "templates/registration_request.html", "templates/form_input.html", "templates/spinner.html", "converse-controlbox" ], factory); }(this, function ( utils, converse, tpl_form_username, tpl_register_link, tpl_register_panel, tpl_registration_form, tpl_registration_request, tpl_form_input, tpl_spinner ) { "use strict"; // Strophe methods for building stanzas const { Strophe, Backbone, sizzle, $iq, _ } = converse.env; // Add Strophe Namespaces Strophe.addNamespace('REGISTER', 'jabber:iq:register'); // Add Strophe Statuses let i = 0; _.each(_.keys(Strophe.Status), 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; converse.plugins.add('converse-register', { 'overrides': { // Overrides mentioned here will be picked up by converse.js's // plugin architecture they will replace existing methods on the // relevant objects or classes. // // New functions which don't exist yet can also be added. LoginPanel: { insertRegisterLink () { const { _converse } = this.__super__; if (_.isUndefined(this.registerlinkview)) { this.registerlinkview = new _converse.RegisterLinkView({'model': this.model}); this.registerlinkview.render(); this.el.querySelector('.buttons').insertAdjacentElement('afterend', this.registerlinkview.el); } this.registerlinkview.render(); }, render (cfg) { const { _converse } = this.__super__; this.__super__.render.apply(this, arguments); if (_converse.allow_registration && !_converse.auto_login) { this.insertRegisterLink(); } return this; } }, ControlBoxView: { initialize () { this.__super__.initialize.apply(this, arguments); this.model.on('change:active-form', this.showLoginOrRegisterForm.bind(this)) }, showLoginOrRegisterForm () { const { _converse } = this.__super__; if (_.isNil(this.registerpanel)) { return; } if (this.model.get('active-form') == "register") { this.loginpanel.el.classList.add('hidden'); this.registerpanel.el.classList.remove('hidden'); } else { this.loginpanel.el.classList.remove('hidden'); this.registerpanel.el.classList.add('hidden'); } }, renderRegistrationPanel () { const { _converse } = this.__super__; if (_converse.allow_registration) { this.registerpanel = new _converse.RegisterPanel({ 'model': this.model }); this.registerpanel.render(); this.registerpanel.el.classList.add('hidden'); this.el.querySelector('#converse-login-panel').insertAdjacentElement( 'afterend', this.registerpanel.el ); this.showLoginOrRegisterForm(); } return this; }, renderLoginPanel () { /* Also render a registration panel, when rendering the * login panel. */ this.__super__.renderLoginPanel.apply(this, arguments); this.renderRegistrationPanel(); return this; } } }, initialize () { /* The initialize function gets called as soon as the plugin is * loaded by converse.js's plugin machinery. */ const { _converse } = this, { __ } = _converse; _converse.CONNECTION_STATUS[Strophe.Status.REGIFAIL] = 'REGIFAIL'; _converse.CONNECTION_STATUS[Strophe.Status.REGISTERED] = 'REGISTERED'; _converse.CONNECTION_STATUS[Strophe.Status.CONFLICT] = 'CONFLICT'; _converse.CONNECTION_STATUS[Strophe.Status.NOTACCEPTABLE] = 'NOTACCEPTABLE'; _converse.api.settings.update({ 'allow_registration': true, 'domain_placeholder': __(" e.g. conversejs.org"), // Placeholder text shown in the domain input on the registration form 'providers_link': 'https://xmpp.net/directory.php', // Link to XMPP providers shown on registration page 'registration_domain': '' }); function setActiveForm (value) { _converse.api.waitUntil('controlboxInitialized').then(() => { const controlbox = _converse.chatboxes.get('controlbox') controlbox.set({'active-form': value}); }).catch(_.partial(_converse.log, _, Strophe.LogLevel.FATAL)); } _converse.router.route('converse/login', _.partial(setActiveForm, 'login')); _converse.router.route('converse/register', _.partial(setActiveForm, 'register')); _converse.RegisterLinkView = Backbone.VDOMView.extend({ toHTML () { return tpl_register_link( _.extend(this.model.toJSON(), { '__': _converse.__, '_converse': _converse, 'connection_status': _converse.connfeedback.get('connection_status'), })); } }); _converse.RegisterPanel = Backbone.NativeView.extend({ tagName: 'div', id: "converse-register-panel", className: 'controlbox-pane fade-in', events: { 'submit form#converse-register': 'onFormSubmission', 'click .button-cancel': 'renderProviderChoiceForm', }, initialize (cfg) { this.reset(); this.registerHooks(); }, render () { this.model.set('registration_form_rendered', false); this.el.innerHTML = tpl_register_panel({ '__': __, 'default_domain': _converse.registration_domain, 'label_register': __('Fetch registration form'), 'help_providers': __('Tip: A list of public XMPP providers is available'), 'help_providers_link': __('here'), 'href_providers': _converse.providers_link, 'domain_placeholder': _converse.domain_placeholder }); if (_converse.registration_domain) { this.fetchRegistrationForm( _converse.registration_domain ); } return this; }, registerHooks () { /* Hook into Strophe's _connect_cb, so that we can send an IQ * requesting the registration fields. */ const conn = _converse.connection; const connect_cb = conn._connect_cb.bind(conn); conn._connect_cb = (req, callback, raw) => { if (!this._registering) { connect_cb(req, callback, raw); } else { if (this.getRegistrationFields(req, callback, raw)) { this._registering = false; } } }; }, getRegistrationFields (req, _callback, raw) { /* Send an IQ stanza to the XMPP server asking for the * registration fields. * Parameters: * (Strophe.Request) req - The current request * (Function) callback */ const conn = _converse.connection; conn.connected = true; const body = conn._proto._reqToData(req); if (!body) { return; } if (conn._proto._connect_cb(body) === Strophe.Status.CONNFAIL) { this.showValidationError( __("Sorry, we're unable to connect to your chosen provider.") ); return false; } const register = body.getElementsByTagName("register"); const mechanisms = body.getElementsByTagName("mechanism"); if (register.length === 0 && mechanisms.length === 0) { conn._proto._no_auth_received(_callback); return false; } if (register.length === 0) { conn._changeConnectStatus(Strophe.Status.REGIFAIL); this.showValidationError( __("Sorry, the given provider does not support in "+ "band account registration. Please try with a "+ "different provider.")) return true; } // Send an IQ stanza to get all required data fields conn._addSysHandler(this.onRegistrationFields.bind(this), null, "iq", null, null); const stanza = $iq({type: "get"}).c("query", {xmlns: Strophe.NS.REGISTER}).tree(); stanza.setAttribute("id", conn.getUniqueId("sendIQ")); conn.send(stanza); conn.connected = false; return true; }, onRegistrationFields (stanza) { /* Handler for Registration Fields Request. * * Parameters: * (XMLElement) elem - The query stanza. */ if (stanza.getAttribute("type") === "error") { _converse.connection._changeConnectStatus( Strophe.Status.REGIFAIL, __('Something went wrong while establishing a connection with "%1$s". '+ 'Are you sure it exists?', this.domain) ); return false; } if (stanza.getElementsByTagName("query").length !== 1) { _converse.connection._changeConnectStatus( Strophe.Status.REGIFAIL, "unknown" ); return false; } this.setFields(stanza); if (!this.model.get('registration_form_rendered')) { this.renderRegistrationForm(stanza); } return false; }, reset (settings) { const defaults = { fields: {}, urls: [], title: "", instructions: "", registered: false, _registering: false, domain: null, form_type: null }; _.extend(this, defaults); if (settings) { _.extend(this, _.pick(settings, _.keys(defaults))); } }, onFormSubmission (ev) { /* Event handler when the #converse-register form is * submitted. * * Depending on the available input fields, we delegate to * other methods. */ if (ev && ev.preventDefault) { ev.preventDefault(); } if (_.isNull(ev.target.querySelector('input[name=domain]'))) { this.submitRegistrationForm(ev.target); } else { this.onProviderChosen(ev.target); } }, onProviderChosen (form) { /* Callback method that gets called when the user has chosen an * XMPP provider. * * Parameters: * (HTMLElement) form - The form that was submitted */ const domain_input = form.querySelector('input[name=domain]'), domain = _.get(domain_input, 'value'); if (!domain) { // TODO: add validation message domain_input.classList.add('error'); return; } form.querySelector('input[type=submit]').classList.add('hidden'); this.fetchRegistrationForm(domain.trim()); }, fetchRegistrationForm (domain_name) { /* This is called with a domain name based on which, it fetches a * registration form from the requested domain. * * Parameters: * (String) domain_name - XMPP server domain */ if (!this.model.get('registration_form_rendered')) { this.renderRegistrationRequest(); } this.reset({ domain: Strophe.getDomainFromJid(domain_name), _registering: true }); _converse.connection.connect( this.domain, "", this.onConnectStatusChanged.bind(this) ); return false; }, renderRegistrationRequest () { /* Clear the form and inform the user that the registration * form is being fetched. */ this.clearRegistrationForm().insertAdjacentHTML( 'beforeend', tpl_registration_request({ '__': _converse.__, 'cancel': _converse.registration_domain, }) ); }, giveFeedback (message, klass) { let feedback = this.el.querySelector('.reg-feedback'); if (!_.isNull(feedback)) { feedback.parentNode.removeChild(feedback); } const form = this.el.querySelector('form'); form.insertAdjacentHTML( 'afterbegin', '' ); feedback = form.querySelector('.reg-feedback'); feedback.textContent = message; if (klass) { feedback.classList.add(klass); } }, clearRegistrationForm () { const form = this.el.querySelector('form'); form.innerHTML = ''; this.model.set('registration_form_rendered', false); return form; }, showSpinner () { const form = this.el.querySelector('form'); form.innerHTML = tpl_spinner(); this.model.set('registration_form_rendered', false); return this; }, onConnectStatusChanged(status_code) { /* Callback function called by Strophe whenever the * connection status changes. * * Passed to Strophe specifically during a registration * attempt. * * Parameters: * (Integer) status_code - The Stroph.Status status code */ _converse.log('converse-register: onConnectStatusChanged'); if (_.includes([ Strophe.Status.DISCONNECTED, Strophe.Status.CONNFAIL, Strophe.Status.REGIFAIL, Strophe.Status.NOTACCEPTABLE, Strophe.Status.CONFLICT ], status_code)) { _converse.log( `Problem during registration: Strophe.Status is ${_converse.CONNECTION_STATUS[status_code]}`, Strophe.LogLevel.ERROR ); this.abortRegistration(); } else if (status_code === Strophe.Status.REGISTERED) { _converse.log("Registered successfully."); _converse.connection.reset(); this.showSpinner(); if (_.includes(["converse/login", "converse/register"], Backbone.history.getFragment())) { _converse.router.navigate('', {'replace': true}); } if (this.fields.password && this.fields.username) { // automatically log the user in _converse.connection.connect( this.fields.username.toLowerCase()+'@'+this.domain.toLowerCase(), this.fields.password, _converse.onConnectStatusChanged ); this.giveFeedback(__('Now logging you in'), 'info'); } else { _converse.chatboxviews.get('controlbox').renderLoginPanel(); _converse.giveFeedback(__('Registered successfully')); } this.reset(); } }, renderLegacyRegistrationForm (form) { _.each(_.keys(this.fields), (key) => { if (key === "username") { form.insertAdjacentHTML( 'beforeend', tpl_form_username({ 'domain': ` @${this.domain}`, 'name': key, 'type': "text", 'label': key, 'value': '', 'required': true }) ); } else { form.insertAdjacentHTML( 'beforeend', tpl_form_input({ 'label': key, 'name': key, 'placeholder': key, 'required': true, 'type': (key === 'password' || key === 'email') ? key : "text", 'value': '' }) ); } }); // Show urls _.each(this.urls, (url) => { form.insertAdjacentHTML( 'afterend', ''+url+'' ); }); }, renderRegistrationForm (stanza) { /* Renders the registration form based on the XForm fields * received from the XMPP server. * * Parameters: * (XMLElement) stanza - The IQ stanza received from the XMPP server. */ const form = this.el.querySelector('form'); form.innerHTML = tpl_registration_form({ '__': _converse.__, 'domain': this.domain, 'title': this.title, 'instructions': this.instructions, 'registration_domain': _converse.registration_domain }); const buttons = form.querySelector('fieldset.buttons'); if (this.form_type === 'xform') { _.each(stanza.querySelectorAll('field'), (field) => { buttons.insertAdjacentHTML( 'beforebegin', utils.xForm2webForm(field, stanza, this.domain) ); }); } else { this.renderLegacyRegistrationForm(form); } if (!this.fields) { form.querySelector('.button-primary').classList.add('hidden'); } form.classList.remove('hidden'); this.model.set('registration_form_rendered', true); }, showValidationError (message) { const form = this.el.querySelector('form'); let flash = form.querySelector('.form-errors'); if (_.isNull(flash)) { flash = ''; const instructions = form.querySelector('p.instructions'); if (_.isNull(instructions)) { form.insertAdjacentHTML('afterbegin', flash); } else { instructions.insertAdjacentHTML('afterend', flash); } flash = form.querySelector('.form-errors'); } else { flash.innerHTML = ''; } flash.insertAdjacentHTML( 'beforeend', '

'+message+'

' ); flash.classList.remove('hidden'); }, reportErrors (stanza) { /* Report back to the user any error messages received from the * XMPP server after attempted registration. * * Parameters: * (XMLElement) stanza - The IQ stanza received from the * XMPP server. */ const errors = stanza.querySelectorAll('error'); _.each(errors, (error) => { this.showValidationError(error.textContent); }); if (!errors.length) { const message = __('The provider rejected your registration attempt. '+ 'Please check the values you entered for correctness.'); this.showValidationError(message); } }, renderProviderChoiceForm (ev) { if (ev && ev.preventDefault) { ev.preventDefault(); } _converse.connection._proto._abortAllRequests(); _converse.connection.reset(); this.render(); }, abortRegistration () { _converse.connection._proto._abortAllRequests(); _converse.connection.reset(); if (this.model.get('registration_form_rendered')) { if (_converse.registration_domain && this.model.get('registration_form_rendered')) { this.fetchRegistrationForm( _converse.registration_domain ); } } else { this.render(); } }, submitRegistrationForm (form) { /* Handler, when the user submits the registration form. * Provides form error feedback or starts the registration * process. * * Parameters: * (HTMLElement) form - The HTML form that was submitted */ const has_empty_inputs = _.reduce( this.el.querySelectorAll('input.required'), function (result, input) { if (input.value === '') { input.classList.add('error'); return result + 1; } return result; }, 0); if (has_empty_inputs) { return; } const inputs = sizzle(':input:not([type=button]):not([type=submit])', form), iq = $iq({'type': 'set', 'id': _converse.connection.getUniqueId()}) .c("query", {xmlns:Strophe.NS.REGISTER}); if (this.form_type === 'xform') { iq.c("x", {xmlns: Strophe.NS.XFORM, type: 'submit'}); _.each(inputs, (input) => { iq.cnode(utils.webForm2xForm(input)).up(); }); } else { _.each(inputs, (input) => { iq.c(input.getAttribute('name'), {}, input.value); }); } _converse.connection._addSysHandler(this._onRegisterIQ.bind(this), null, "iq", null, null); _converse.connection.send(iq); this.setFields(iq.tree()); }, setFields (stanza) { /* Stores the values that will be sent to the XMPP server * during attempted registration. * * Parameters: * (XMLElement) stanza - the IQ stanza that will be sent to the XMPP server. */ const query = stanza.querySelector('query'); const xform = sizzle(`x[xmlns="${Strophe.NS.XFORM}"]`, query); if (xform.length > 0) { this._setFieldsFromXForm(xform.pop()); } else { this._setFieldsFromLegacy(query); } }, _setFieldsFromLegacy (query) { _.each(query.children, (field) => { if (field.tagName.toLowerCase() === 'instructions') { this.instructions = Strophe.getText(field); return; } else if (field.tagName.toLowerCase() === 'x') { if (field.getAttribute('xmlns') === 'jabber:x:oob') { this.urls.concat(_.map(field.querySelectorAll('url'), 'textContent')); } return; } this.fields[field.tagName.toLowerCase()] = Strophe.getText(field); }); this.form_type = 'legacy'; }, _setFieldsFromXForm (xform) { this.title = _.get(xform.querySelector('title'), 'textContent'); this.instructions = _.get(xform.querySelector('instructions'), 'textContent'); _.each(xform.querySelectorAll('field'), (field) => { const _var = field.getAttribute('var'); if (_var) { this.fields[_var.toLowerCase()] = _.get(field.querySelector('value'), 'textContent', ''); } else { // TODO: other option seems to be type="fixed" _converse.log("Found field we couldn't parse", Strophe.LogLevel.WARN); } }); this.form_type = 'xform'; }, _onRegisterIQ (stanza) { /* Callback method that gets called when a return IQ stanza * is received from the XMPP server, after attempting to * register a new user. * * Parameters: * (XMLElement) stanza - The IQ stanza. */ if (stanza.getAttribute("type") === "error") { _converse.log("Registration failed.", Strophe.LogLevel.ERROR); this.reportErrors(stanza); let error = stanza.getElementsByTagName("error"); if (error.length !== 1) { _converse.connection._changeConnectStatus(Strophe.Status.REGIFAIL, "unknown"); return false; } error = error[0].firstChild.tagName.toLowerCase(); if (error === 'conflict') { _converse.connection._changeConnectStatus(Strophe.Status.CONFLICT, error); } else if (error === 'not-acceptable') { _converse.connection._changeConnectStatus(Strophe.Status.NOTACCEPTABLE, error); } else { _converse.connection._changeConnectStatus(Strophe.Status.REGIFAIL, error); } } else { _converse.connection._changeConnectStatus(Strophe.Status.REGISTERED, null); } return false; } }); } }); }));