jiti-meet/react/features/chrome-extension-banner/components/ChromeExtensionBanner.web.js

284 lines
8.6 KiB
JavaScript
Raw Normal View History

// @flow
import React, { PureComponent } from 'react';
import { connect } from '../../base/redux';
import { Icon, IconClose } from '../../base/icons';
import { translate } from '../../base/i18n';
import { getCurrentConference } from '../../base/conference/functions';
import { browser } from '../../base/lib-jitsi-meet';
2020-02-25 12:41:13 +00:00
import {
checkChromeExtensionsInstalled,
isMobileBrowser
} from '../../base/environment/utils';
import logger from '../logger';
2020-02-25 12:41:13 +00:00
import {
createChromeExtensionBannerEvent,
sendAnalytics
} from '../../analytics';
declare var interfaceConfig: Object;
const emptyObject = {};
/**
* Local storage key name for flag telling if user checked 'Don't show again' checkbox on the banner
* If the user checks this before closing the banner, next time he will access a jitsi domain
* the banner will not be shown regardless of extensions being installed or not.
*/
const DONT_SHOW_AGAIN_CHECKED = 'hide_chrome_extension_banner';
/**
* The type of the React {@code PureComponent} props of {@link ChromeExtensionBanner}.
*/
type Props = {
/**
2020-02-25 12:41:13 +00:00
* Contains info about installed/to be installed chrome extension(s).
*/
2020-02-25 12:41:13 +00:00
bannerCfg: Object,
/**
2020-02-25 12:41:13 +00:00
* Conference data, if any
*/
2020-02-25 12:41:13 +00:00
conference: Object,
/**
* Whether I am the current recorder.
*/
iAmRecorder: boolean,
/**
* Invoked to obtain translated strings.
*/
t: Function,
};
/**
* The type of the React {@link PureComponent} state of {@link ChromeExtensionBanner}.
*/
type State = {
/**
* Keeps the current value of dont show again checkbox
*/
dontShowAgainChecked: boolean,
/**
* Tells whether user pressed install extension or close button.
*/
closePressed: boolean,
/**
* Tells whether should show the banner or not based on extension being installed or not.
*/
shouldShow: boolean,
};
/**
* Implements a React {@link PureComponent} which displays a banner having a link to the chrome extension.
* @class ChromeExtensionBanner
* @extends PureComponent
*/
class ChromeExtensionBanner extends PureComponent<Props, State> {
/**
* Initializes a new {@code ChromeExtensionBanner} instance.
*
* @param {Object} props - The read-only React {@code PureComponent} props with
* which the new instance is to be initialized.
*/
constructor(props: Props) {
super(props);
this.state = {
dontShowAgainChecked: false,
closePressed: false,
shouldShow: false
};
this._onClosePressed = this._onClosePressed.bind(this);
this._onInstallExtensionClick = this._onInstallExtensionClick.bind(this);
this._shouldNotRender = this._shouldNotRender.bind(this);
this._onDontShowAgainChange = this._onDontShowAgainChange.bind(this);
}
/**
* Executed on component update.
* Checks whether any chrome extension from the config is installed.
*
* @inheritdoc
*/
async componentDidUpdate(prevProps) {
if (!this._isSupportedEnvironment()) {
return;
}
2020-02-25 12:41:13 +00:00
const { bannerCfg } = this.props;
const prevBannerCfg = prevProps.bannerCfg;
if (bannerCfg.url && !prevBannerCfg.url) {
logger.info('Chrome extension URL found.');
}
2020-02-25 12:41:13 +00:00
if ((bannerCfg.chromeExtensionsInfo || []).length && !(prevBannerCfg.chromeExtensionsInfo || []).length) {
logger.info('Chrome extension(s) info found.');
}
2020-02-25 12:41:13 +00:00
const hasExtensions = await checkChromeExtensionsInstalled(this.props.bannerCfg);
if (
hasExtensions
&& hasExtensions.length
&& hasExtensions.every(ext => !ext)
&& !this.state.shouldShow
) {
this.setState({ shouldShow: true }); // eslint-disable-line
}
}
/**
* Checks whether the feature is enabled and whether the environment(browser/os)
* supports it.
*
* @returns {boolean}
*/
_isSupportedEnvironment() {
return interfaceConfig.SHOW_CHROME_EXTENSION_BANNER
&& browser.isChrome()
&& !isMobileBrowser();
}
_onClosePressed: () => void;
/**
* Closes the banner for the current session.
*
* @returns {void}
*/
_onClosePressed() {
2020-02-25 12:41:13 +00:00
sendAnalytics(createChromeExtensionBannerEvent(false));
this.setState({ closePressed: true });
}
_onInstallExtensionClick: () => void;
/**
* Opens the chrome extension page.
*
* @returns {void}
*/
_onInstallExtensionClick() {
2020-02-25 12:41:13 +00:00
sendAnalytics(createChromeExtensionBannerEvent(true));
window.open(this.props.bannerCfg.url);
this.setState({ closePressed: true });
}
_shouldNotRender: () => boolean;
/**
* Checks whether the banner should not be rendered.
*
2020-01-23 14:20:04 +00:00
* @returns {boolean} Whether to show the banner or not.
*/
_shouldNotRender() {
if (!this._isSupportedEnvironment()) {
return true;
}
const dontShowAgain = localStorage.getItem(DONT_SHOW_AGAIN_CHECKED) === 'true';
2020-02-25 12:41:13 +00:00
return !this.props.bannerCfg.url
|| dontShowAgain
|| this.state.closePressed
|| !this.state.shouldShow
|| this.props.iAmRecorder;
}
_onDontShowAgainChange: (object: Object) => void;
/**
* Handles the current `don't show again` checkbox state.
*
* @param {Object} event - Input change event.
* @returns {void}
*/
_onDontShowAgainChange(event) {
this.setState({ dontShowAgainChecked: event.target.checked });
}
/**
* Implements React's {@link PureComponent#render()}.
*
* @inheritdoc
* @returns {ReactElement}
*/
render() {
if (this._shouldNotRender()) {
if (this.state.dontShowAgainChecked) {
localStorage.setItem(DONT_SHOW_AGAIN_CHECKED, 'true');
}
return null;
}
const { t } = this.props;
const mainClassNames = this.props.conference
? 'chrome-extension-banner chrome-extension-banner__pos_in_meeting'
: 'chrome-extension-banner';
return (
<div className = { mainClassNames }>
<div className = 'chrome-extension-banner__container'>
<div
className = 'chrome-extension-banner__icon-container' />
<div
className = 'chrome-extension-banner__text-container'>
{ t('chromeExtensionBanner.installExtensionText') }
</div>
<div
className = 'chrome-extension-banner__close-container'
onClick = { this._onClosePressed }>
<Icon
className = 'gray'
size = { 12 }
src = { IconClose } />
</div>
</div>
<div
className = 'chrome-extension-banner__button-container'>
<div
className = 'chrome-extension-banner__button-open-url'
onClick = { this._onInstallExtensionClick }>
<div
className = 'chrome-extension-banner__button-text'>
{ t('chromeExtensionBanner.buttonText') }
</div>
</div>
</div>
<div className = 'chrome-extension-banner__checkbox-container'>
<label className = 'chrome-extension-banner__checkbox-label'>
<input
checked = { this.state.dontShowAgainChecked }
onChange = { this._onDontShowAgainChange }
type = 'checkbox' />
&nbsp;{ t('chromeExtensionBanner.dontShowAgain') }
</label>
</div>
</div>
);
}
}
/**
* Function that maps parts of Redux state tree into component props.
*
* @param {Object} state - Redux state.
* @returns {Object}
*/
const _mapStateToProps = state => {
return {
// Using emptyObject so that we don't change the reference every time when _mapStateToProps is called.
bannerCfg: state['features/base/config'].chromeExtensionBanner || emptyObject,
conference: getCurrentConference(state),
iAmRecorder: state['features/base/config'].iAmRecorder
};
};
export default translate(connect(_mapStateToProps)(ChromeExtensionBanner));