586 lines
27 KiB
JavaScript
586 lines
27 KiB
JavaScript
// Converse.js (A browser based XMPP chat client)
|
|
// http://conversejs.org
|
|
//
|
|
// Copyright (c) 2012-2017, 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 in-band registration
|
|
* as specified in XEP-0077.
|
|
*/
|
|
(function (root, factory) {
|
|
define(["jquery.noconflict",
|
|
"form-utils",
|
|
"converse-core",
|
|
"tpl!form_username",
|
|
"tpl!register_panel",
|
|
"tpl!register_tab",
|
|
"tpl!registration_form",
|
|
"tpl!registration_request",
|
|
"tpl!spinner",
|
|
"converse-controlbox"
|
|
], factory);
|
|
}(this, function (
|
|
$,
|
|
utils,
|
|
converse,
|
|
tpl_form_username,
|
|
tpl_register_panel,
|
|
tpl_register_tab,
|
|
tpl_registration_form,
|
|
tpl_registration_request,
|
|
tpl_spinner
|
|
) {
|
|
|
|
"use strict";
|
|
|
|
// Strophe methods for building stanzas
|
|
const { Strophe, Backbone, $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.
|
|
|
|
ControlBoxView: {
|
|
|
|
switchTab (ev) {
|
|
const { _converse } = this.__super__;
|
|
const result = this.__super__.switchTab.apply(this, arguments);
|
|
if (_converse.registration_domain &&
|
|
ev.target.getAttribute('data-id') === "register" &&
|
|
!this.model.get('registration_form_rendered')) {
|
|
this.registerpanel.fetchRegistrationForm(_converse.registration_domain);
|
|
}
|
|
return result;
|
|
},
|
|
|
|
renderRegistrationPanel () {
|
|
const { _converse } = this.__super__;
|
|
if (_converse.allow_registration) {
|
|
this.registerpanel = new _converse.RegisterPanel({
|
|
'$parent': this.$el.find('.controlbox-panes'),
|
|
'model': this.model
|
|
});
|
|
this.registerpanel.render().$el.addClass('hidden');
|
|
}
|
|
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;
|
|
|
|
// Add new templates
|
|
_converse.templates.form_username = tpl_form_username;
|
|
_converse.templates.register_panel = tpl_register_panel;
|
|
_converse.templates.register_tab = tpl_register_tab;
|
|
_converse.templates.registration_form = tpl_registration_form;
|
|
_converse.templates.registration_request = tpl_registration_request;
|
|
|
|
_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
|
|
});
|
|
|
|
_converse.RegisterPanel = Backbone.View.extend({
|
|
tagName: 'div',
|
|
id: "register",
|
|
className: 'controlbox-pane',
|
|
events: {
|
|
'submit form#converse-register': 'onProviderChosen'
|
|
},
|
|
|
|
initialize (cfg) {
|
|
this.reset();
|
|
this.$parent = cfg.$parent;
|
|
this.$tabs = cfg.$parent.parent().find('#controlbox-tabs');
|
|
this.registerHooks();
|
|
},
|
|
|
|
render () {
|
|
this.model.set('registration_form_rendered', false);
|
|
this.$parent.append(this.$el.html(
|
|
tpl_register_panel({
|
|
'default_domain': _converse.registration_domain,
|
|
'label_domain': __("Your XMPP provider's domain name:"),
|
|
'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
|
|
})
|
|
));
|
|
this.$tabs.append(tpl_register_tab({label_register: __('Register')}));
|
|
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) {
|
|
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,
|
|
__("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);
|
|
conn.send($iq({type: "get"}).c("query", {xmlns: Strophe.NS.REGISTER}).tree());
|
|
conn.connected = false;
|
|
return true;
|
|
},
|
|
|
|
onRegistrationFields (stanza) {
|
|
/* Handler for Registration Fields Request.
|
|
*
|
|
* Parameters:
|
|
* (XMLElement) elem - The query stanza.
|
|
*/
|
|
if (stanza.getElementsByTagName("query").length !== 1) {
|
|
_converse.connection._changeConnectStatus(Strophe.Status.REGIFAIL, "unknown");
|
|
return false;
|
|
}
|
|
this.setFields(stanza);
|
|
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)));
|
|
}
|
|
},
|
|
|
|
onProviderChosen (ev) {
|
|
/* Callback method that gets called when the user has chosen an
|
|
* XMPP provider.
|
|
*
|
|
* Parameters:
|
|
* (Submit Event) ev - Form submission event.
|
|
*/
|
|
if (ev && ev.preventDefault) { ev.preventDefault(); }
|
|
const $form = $(ev.target),
|
|
$domain_input = $form.find('input[name=domain]'),
|
|
domain = $domain_input.val();
|
|
if (!domain) {
|
|
$domain_input.addClass('error');
|
|
return;
|
|
}
|
|
$form.find('input[type=submit]').hide();
|
|
this.fetchRegistrationForm(domain, __('Cancel'));
|
|
},
|
|
|
|
fetchRegistrationForm (domain_name, cancel_label) {
|
|
/* This is called with a domain name based on which, it fetches a
|
|
* registration form from the requested domain.
|
|
*
|
|
* Parameters:
|
|
* (Domain name) domain_name - XMPP server domain
|
|
*/
|
|
this.renderRegistrationRequest(cancel_label);
|
|
this.reset({
|
|
domain: Strophe.getDomainFromJid(domain_name),
|
|
_registering: true
|
|
});
|
|
_converse.connection.connect(this.domain, "", this.onRegistering.bind(this));
|
|
return false;
|
|
},
|
|
|
|
renderRegistrationRequest (cancel_label) {
|
|
const form = this.el.querySelector('#converse-register');
|
|
const markup = tpl_registration_request({
|
|
'cancel': cancel_label,
|
|
'info_message': _converse.__('Requesting a registration form from the XMPP server')
|
|
});
|
|
form.appendChild(utils.createFragmentFromText(markup));
|
|
if (!_converse.registration_domain) {
|
|
const cancel_button = document.querySelector('button.button-cancel');
|
|
cancel_button.addEventListener('click', this.cancelRegistration.bind(this));
|
|
}
|
|
},
|
|
|
|
giveFeedback (message, klass) {
|
|
this.$('.reg-feedback').attr('class', 'reg-feedback').text(message);
|
|
if (klass) {
|
|
$('.reg-feedback').addClass(klass);
|
|
}
|
|
},
|
|
|
|
onRegistering (status, error) {
|
|
let that;
|
|
_converse.log('onRegistering');
|
|
if (_.includes([
|
|
Strophe.Status.DISCONNECTED,
|
|
Strophe.Status.CONNFAIL,
|
|
Strophe.Status.REGIFAIL,
|
|
Strophe.Status.NOTACCEPTABLE,
|
|
Strophe.Status.CONFLICT
|
|
], status)) {
|
|
|
|
_converse.log(
|
|
`Problem during registration: Strophe.Status is: ${status}`,
|
|
Strophe.LogLevel.ERROR
|
|
);
|
|
this.cancelRegistration();
|
|
if (error) {
|
|
this.giveFeedback(error, 'error');
|
|
} else {
|
|
this.giveFeedback(__(
|
|
'Something went wrong while establishing a connection with "%1$s". Are you sure it exists?',
|
|
this.domain
|
|
), 'error');
|
|
}
|
|
} else if (status === Strophe.Status.REGISTERED) {
|
|
_converse.log("Registered successfully.");
|
|
_converse.connection.reset();
|
|
that = this;
|
|
this.$('form').hide(function () {
|
|
$(this).replaceWith(tpl_spinner);
|
|
if (that.fields.password && that.fields.username) {
|
|
// automatically log the user in
|
|
_converse.connection.connect(
|
|
that.fields.username.toLowerCase()+'@'+that.domain.toLowerCase(),
|
|
that.fields.password,
|
|
_converse.onConnectStatusChanged
|
|
);
|
|
_converse.chatboxviews.get('controlbox')
|
|
.switchTab({'target': that.$tabs.find('.current')});
|
|
_converse.giveFeedback(__('Now logging you in'));
|
|
} else {
|
|
_converse.chatboxviews.get('controlbox').renderLoginPanel();
|
|
_converse.giveFeedback(__('Registered successfully'));
|
|
}
|
|
that.reset();
|
|
});
|
|
}
|
|
},
|
|
|
|
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.
|
|
*/
|
|
this.model.set('registration_form_rendered', true);
|
|
|
|
const $form = this.$('form'),
|
|
$stanza = $(stanza);
|
|
let $fields, $input;
|
|
$form.empty().append(tpl_registration_form({
|
|
'domain': this.domain,
|
|
'title': this.title,
|
|
'instructions': this.instructions
|
|
}));
|
|
if (this.form_type === 'xform') {
|
|
$fields = $stanza.find('field');
|
|
_.each($fields, (field) => {
|
|
$form.append(utils.xForm2webForm.bind(this, field, stanza));
|
|
});
|
|
} else {
|
|
// Show fields
|
|
_.each(_.keys(this.fields), (key) => {
|
|
if (key === "username") {
|
|
$input = tpl_form_username({
|
|
domain: ` @${this.domain}`,
|
|
name: key,
|
|
type: "text",
|
|
label: key,
|
|
value: '',
|
|
required: 1
|
|
});
|
|
} else {
|
|
$form.append(`<label>${key}</label>`);
|
|
$input = $(`<input placeholder="${key}" name="${key}"></input>`);
|
|
if (key === 'password' || key === 'email') {
|
|
$input.attr('type', key);
|
|
}
|
|
}
|
|
$form.append($input);
|
|
});
|
|
// Show urls
|
|
_.each(this.urls, (url) => {
|
|
$form.append($('<a target="blank"></a>').attr('href', url).text(url));
|
|
});
|
|
}
|
|
if (this.fields) {
|
|
$form.append(`<input type="submit" class="pure-button button-primary" value="${__('Register')}"/>`);
|
|
$form.on('submit', this.submitRegistrationForm.bind(this));
|
|
$form.append(`<input type="button" class="pure-button button-cancel" value="${__('Cancel')}"/>`);
|
|
$form.find('input[type=button]').on('click', this.cancelRegistration.bind(this));
|
|
} else {
|
|
$form.append(`<input type="button" class="submit" value="${__('Return')}"/>`);
|
|
$form.find('input[type=button]').on('click', this.cancelRegistration.bind(this));
|
|
}
|
|
if (_converse.registration_domain) {
|
|
$form.find('input[type=button]').hide();
|
|
}
|
|
},
|
|
|
|
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 $form= this.$('form'),
|
|
$errmsgs = $(stanza).find('error text');
|
|
|
|
let $flash = $form.find('.form-errors');
|
|
if (!$flash.length) {
|
|
const flash = '<legend class="form-errors"></legend>';
|
|
if ($form.find('p.instructions').length) {
|
|
$form.find('p.instructions').append(flash);
|
|
} else {
|
|
$form.prepend(flash);
|
|
}
|
|
$flash = $form.find('.form-errors');
|
|
} else {
|
|
$flash.empty();
|
|
}
|
|
$errmsgs.each(function (idx, txt) {
|
|
$flash.append($('<p>').text($(txt).text()));
|
|
});
|
|
if (!$errmsgs.length) {
|
|
$flash.append($('<p>').text(
|
|
__('The provider rejected your registration attempt. '+
|
|
'Please check the values you entered for correctness.')));
|
|
}
|
|
$flash.show();
|
|
},
|
|
|
|
cancelRegistration (ev) {
|
|
/* Handler, when the user cancels the registration form.
|
|
*/
|
|
if (ev && ev.preventDefault) { ev.preventDefault(); }
|
|
_converse.connection.reset();
|
|
this.model.set('registration_form_rendered', false);
|
|
this.render();
|
|
if (_converse.registration_domain) {
|
|
document.querySelector('button.button-cancel').onclick =
|
|
_.bind(
|
|
this.fetchRegistrationForm, this,
|
|
_converse.registration_domain, __('Retry')
|
|
);
|
|
}
|
|
},
|
|
|
|
submitRegistrationForm (ev) {
|
|
/* Handler, when the user submits the registration form.
|
|
* Provides form error feedback or starts the registration
|
|
* process.
|
|
*
|
|
* Parameters:
|
|
* (Event) ev - the submit event.
|
|
*/
|
|
if (ev && ev.preventDefault) { ev.preventDefault(); }
|
|
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 = $(ev.target).find(':input:not([type=button]):not([type=submit])'),
|
|
iq = $iq({type: "set"}).c("query", {xmlns:Strophe.NS.REGISTER});
|
|
|
|
if (this.form_type === 'xform') {
|
|
iq.c("x", {xmlns: Strophe.NS.XFORM, type: 'submit'});
|
|
$inputs.each(function () {
|
|
iq.cnode(utils.webForm2xForm(this)).up();
|
|
});
|
|
} else {
|
|
$inputs.each(function () {
|
|
const $input = $(this);
|
|
iq.c($input.attr('name'), {}, $input.val());
|
|
});
|
|
}
|
|
this.model.set('registration_form_rendered', false);
|
|
_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).find('query');
|
|
if ($query.length > 0) {
|
|
const $xform = $query.find(`x[xmlns="${Strophe.NS.XFORM}"]`);
|
|
if ($xform.length > 0) {
|
|
this._setFieldsFromXForm($xform);
|
|
} else {
|
|
this._setFieldsFromLegacy($query);
|
|
}
|
|
}
|
|
},
|
|
|
|
_setFieldsFromLegacy ($query) {
|
|
$query.children().each((idx, field) => {
|
|
const $field = $(field);
|
|
if (field.tagName.toLowerCase() === 'instructions') {
|
|
this.instructions = Strophe.getText(field);
|
|
return;
|
|
} else if (field.tagName.toLowerCase() === 'x') {
|
|
if ($field.attr('xmlns') === 'jabber:x:oob') {
|
|
$field.find('url').each((idx, url) => {
|
|
this.urls.push($(url).text());
|
|
});
|
|
}
|
|
return;
|
|
}
|
|
this.fields[field.tagName.toLowerCase()] = Strophe.getText(field);
|
|
});
|
|
this.form_type = 'legacy';
|
|
},
|
|
|
|
_setFieldsFromXForm ($xform) {
|
|
this.title = $xform.find('title').text();
|
|
this.instructions = $xform.find('instructions').text();
|
|
$xform.find('field').each((idx, field) => {
|
|
const _var = field.getAttribute('var');
|
|
if (_var) {
|
|
this.fields[_var.toLowerCase()] = $(field).children('value').text();
|
|
} 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.
|
|
*/
|
|
let error = null,
|
|
query = stanza.getElementsByTagName("query");
|
|
if (query.length > 0) {
|
|
query = query[0];
|
|
}
|
|
if (stanza.getAttribute("type") === "error") {
|
|
_converse.log("Registration failed.", Strophe.LogLevel.ERROR);
|
|
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);
|
|
}
|
|
this.reportErrors(stanza);
|
|
} else {
|
|
_converse.connection._changeConnectStatus(Strophe.Status.REGISTERED, null);
|
|
}
|
|
return false;
|
|
},
|
|
|
|
remove () {
|
|
this.$tabs.empty();
|
|
this.$el.parent().empty();
|
|
}
|
|
});
|
|
}
|
|
});
|
|
}));
|