element-web/src/Registration.js

/*
Copyright 2018 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
 * Utility code for registering with a homeserver
 * Note that this is currently *not* used by the actual
 * registration code.
 */

import dis from './dispatcher';
import sdk from './index';
import MatrixClientPeg from './MatrixClientPeg';
import Modal from './Modal';
import { _t } from './languageHandler';

/**
 * Starts either the ILAG or full registration flow, depending
 * on what the HS supports
 *
 * @param {object} options
 * @param {bool} options.go_home_on_cancel If true, goes to
 *     the hame page if the user cancels the action
 */
export async function startAnyRegistrationFlow(options) {
    if (options === undefined) options = {};
    const flows = await _getRegistrationFlows();
    // look for an ILAG compatible flow. We define this as one
    // which has only dummy or recaptcha flows. In practice it
    // would support any stage InteractiveAuth supports, just not
    // ones like email & msisdn which require the user to supply
    // the relevant details in advance. We err on the side of
    // caution though.
    const hasIlagFlow = flows.some((flow) => {
        return flow.stages.every((stage) => {
            return ['m.login.dummy', 'm.login.recaptcha', 'm.login.terms'].includes(stage);
        });
    });

    if (hasIlagFlow) {
        dis.dispatch({
            action: 'view_set_mxid',
            go_home_on_cancel: options.go_home_on_cancel,
        });
    } else {
        const QuestionDialog = sdk.getComponent("dialogs.QuestionDialog");
        Modal.createTrackedDialog('Registration required', '', QuestionDialog, {
            title: _t("Registration Required"),
            description: _t("You need to register to do this. Would you like to register now?"),
            button: _t("Register"),
            onFinished: (proceed) => {
                if (proceed) {
                    dis.dispatch({action: 'start_registration'});
                } else if (options.go_home_on_cancel) {
                    dis.dispatch({action: 'view_home_page'});
                }
            },
        });
    }
}

async function _getRegistrationFlows() {
    try {
        await MatrixClientPeg.get().register(
            null,
            null,
            undefined,
            {},
            {},
        );
        console.log("Register request succeeded when it should have returned 401!");
    } catch (e) {
        if (e.httpStatus === 401) {
            return e.data.flows;
        }
        throw e;
    }
    throw new Error("Register request succeeded when it should have returned 401!");
}