jitsi_corner8/react/features/overlay/components/OverlayContainer.js

/* global APP */

import React, { Component } from 'react';
import { connect } from 'react-redux';

import PageReloadOverlay from './PageReloadOverlay';
import SuspendedOverlay from './SuspendedOverlay';
import UserMediaPermissionsOverlay from './UserMediaPermissionsOverlay';

/**
 * Implements a React Component that will display the correct overlay when
 * needed.
 */
class OverlayContainer extends Component {
    /**
     * OverlayContainer component's property types.
     *
     * @static
     */
    static propTypes = {
        /**
         * The browser which is used currently.
         * NOTE: Used by UserMediaPermissionsOverlay only.
         * @private
         * @type {string}
         */
        _browser: React.PropTypes.string,

        /**
         * The indicator which determines whether the status of
         * JitsiConnection object has been "established" or not.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {boolean}
         */
        _connectionEstablished: React.PropTypes.bool,

        /**
         * The indicator which determines whether a critical error for reload
         * has been received.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {boolean}
         */
        _haveToReload: React.PropTypes.bool,

        /**
         * The indicator which determines whether the reload was caused by
         * network failure.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {boolean}
         */
        _isNetworkFailure: React.PropTypes.bool,

        /**
         * The indicator which determines whether the GUM permissions prompt
         * is displayed or not.
         * NOTE: Used by UserMediaPermissionsOverlay only.
         * @private
         * @type {boolean}
         */
        _mediaPermissionPromptVisible: React.PropTypes.bool,

        /**
         * The reason for the error that will cause the reload.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {string}
         */
        _reason: React.PropTypes.string,

        /**
         * The indicator which determines whether the GUM permissions prompt
         * is displayed or not.
         * NOTE: Used by SuspendedOverlay only.
         * @private
         * @type {string}
         */
        _suspendDetected: React.PropTypes.bool
    }

    /**
     * React Component method that executes once component is updated.
     *
     * @inheritdoc
     * @returns {void}
     * @protected
     */
    componentDidUpdate() {
        // FIXME: Temporary workaround until everything is moved to react.
        APP.UI.overlayVisible
            = (this.props._connectionEstablished && this.props._haveToReload)
            || this.props._suspendDetected
            || this.props._mediaPermissionPromptVisible;
    }

    /**
     * Implements React's {@link Component#render()}.
     *
     * @inheritdoc
     * @returns {ReactElement|null}
     * @public
     */
    render() {
        if (this.props._connectionEstablished && this.props._haveToReload) {
            return (
                <PageReloadOverlay
                    isNetworkFailure = { this.props._isNetworkFailure }
                    reason = { this.props._reason } />
            );
        }

        if (this.props._suspendDetected) {
            return (
                <SuspendedOverlay />
            );
        }

        if (this.props._mediaPermissionPromptVisible) {
            return (
                <UserMediaPermissionsOverlay
                    browser = { this.props._browser } />
            );
        }

        return null;
    }
}

/**
 * Maps (parts of) the Redux state to the associated OverlayContainer's props.
 *
 * @param {Object} state - The Redux state.
 * @returns {{
 *      _browser: string,
 *      _connectionEstablished: bool,
 *      _haveToReload: bool,
 *      _isNetworkFailure: bool,
 *      _mediaPermissionPromptVisible: bool,
 *      _reason: string,
 *      _suspendDetected: bool
 * }}
 * @private
 */
function _mapStateToProps(state) {
    return {
        /**
         * The browser which is used currently.
         * NOTE: Used by UserMediaPermissionsOverlay only.
         * @private
         * @type {string}
         */
        _browser: state['features/overlay'].browser,

        /**
         * The indicator which determines whether the status of
         * JitsiConnection object has been "established" or not.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {boolean}
         */
        _connectionEstablished:
            state['features/overlay'].connectionEstablished,

        /**
         * The indicator which determines whether a critical error for reload
         * has been received.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {boolean}
         */
        _haveToReload: state['features/overlay'].haveToReload,

        /**
         * The indicator which determines whether the reload was caused by
         * network failure.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {boolean}
         */
        _isNetworkFailure: state['features/overlay'].isNetworkFailure,

        /**
         * The indicator which determines whether the GUM permissions prompt
         * is displayed or not.
         * NOTE: Used by UserMediaPermissionsOverlay only.
         * @private
         * @type {boolean}
         */
        _mediaPermissionPromptVisible:
            state['features/overlay'].mediaPermissionPromptVisible,

        /**
         * The reason for the error that will cause the reload.
         * NOTE: Used by PageReloadOverlay only.
         * @private
         * @type {string}
         */
        _reason: state['features/overlay'].reason,

        /**
         * The indicator which determines whether the GUM permissions prompt
         * is displayed or not.
         * NOTE: Used by SuspendedOverlay only.
         * @private
         * @type {string}
         */
        _suspendDetected: state['features/overlay'].suspendDetected
    };
}

export default connect(_mapStateToProps)(OverlayContainer);