bigbluebutton-Github/bigbluebutton-html5/imports/ui/components/nav-bar/options-dropdown/component.jsx
Guilherme Pereira Leme eb7adfb994
feat(plugins): code refactor for readability (#19222)
* [plugin-sdk-refactor-organization] - rearrange of files and folders (WIP)

* [plugin-sdk-refactor-organization ] - final touches

* [plugin-sdk-refactor-organization ] - fix

* [plugin-sdk-refactor-organization ] - update SDK
2023-11-28 15:31:28 -03:00

459 lines
14 KiB
JavaScript

import React, { PureComponent } from 'react';
import { defineMessages, injectIntl } from 'react-intl';
import PropTypes from 'prop-types';
import EndMeetingConfirmationContainer from '/imports/ui/components/end-meeting-confirmation/container';
import { makeCall } from '/imports/ui/services/api';
import AboutContainer from '/imports/ui/components/about/container';
import MobileAppModal from '/imports/ui/components/mobile-app-modal/container';
import OptionsMenuContainer from '/imports/ui/components/settings/container';
import BBBMenu from '/imports/ui/components/common/menu/component';
import ShortcutHelpComponent from '/imports/ui/components/shortcut-help/component';
import withShortcutHelper from '/imports/ui/components/shortcut-help/service';
import FullscreenService from '/imports/ui/components/common/fullscreen-button/service';
import { colorDanger, colorWhite } from '/imports/ui/stylesheets/styled-components/palette';
import { OptionsDropdownItemType } from 'bigbluebutton-html-plugin-sdk/dist/cjs/extensible-areas/options-dropdown-item/enums';
import Styled from './styles';
import browserInfo from '/imports/utils/browserInfo';
import deviceInfo from '/imports/utils/deviceInfo';
const intlMessages = defineMessages({
optionsLabel: {
id: 'app.navBar.optionsDropdown.optionsLabel',
description: 'Options button label',
},
fullscreenLabel: {
id: 'app.navBar.optionsDropdown.fullscreenLabel',
description: 'Make fullscreen option label',
},
settingsLabel: {
id: 'app.navBar.optionsDropdown.settingsLabel',
description: 'Open settings option label',
},
aboutLabel: {
id: 'app.navBar.optionsDropdown.aboutLabel',
description: 'About option label',
},
aboutDesc: {
id: 'app.navBar.optionsDropdown.aboutDesc',
description: 'Describes about option',
},
leaveSessionLabel: {
id: 'app.navBar.optionsDropdown.leaveSessionLabel',
description: 'Leave session button label',
},
fullscreenDesc: {
id: 'app.navBar.optionsDropdown.fullscreenDesc',
description: 'Describes fullscreen option',
},
settingsDesc: {
id: 'app.navBar.optionsDropdown.settingsDesc',
description: 'Describes settings option',
},
leaveSessionDesc: {
id: 'app.navBar.optionsDropdown.leaveSessionDesc',
description: 'Describes leave session option',
},
exitFullscreenDesc: {
id: 'app.navBar.optionsDropdown.exitFullscreenDesc',
description: 'Describes exit fullscreen option',
},
exitFullscreenLabel: {
id: 'app.navBar.optionsDropdown.exitFullscreenLabel',
description: 'Exit fullscreen option label',
},
hotkeysLabel: {
id: 'app.navBar.optionsDropdown.hotkeysLabel',
description: 'Hotkeys options label',
},
hotkeysDesc: {
id: 'app.navBar.optionsDropdown.hotkeysDesc',
description: 'Describes hotkeys option',
},
helpLabel: {
id: 'app.navBar.optionsDropdown.helpLabel',
description: 'Help options label',
},
openAppLabel: {
id: 'app.navBar.optionsDropdown.openAppLabel',
description: 'Open mobile app label',
},
helpDesc: {
id: 'app.navBar.optionsDropdown.helpDesc',
description: 'Describes help option',
},
endMeetingLabel: {
id: 'app.navBar.optionsDropdown.endMeetingLabel',
description: 'End meeting options label',
},
endMeetingDesc: {
id: 'app.navBar.optionsDropdown.endMeetingDesc',
description: 'Describes settings option closing the current meeting',
},
startCaption: {
id: 'app.audio.captions.button.start',
description: 'Start audio captions',
},
stopCaption: {
id: 'app.audio.captions.button.stop',
description: 'Stop audio captions',
},
});
const propTypes = {
intl: PropTypes.shape({
formatMessage: PropTypes.func.isRequired,
}).isRequired,
handleToggleFullscreen: PropTypes.func.isRequired,
noIOSFullscreen: PropTypes.bool,
amIModerator: PropTypes.bool,
shortcuts: PropTypes.string,
isBreakoutRoom: PropTypes.bool,
isMeteorConnected: PropTypes.bool.isRequired,
isDropdownOpen: PropTypes.bool,
audioCaptionsEnabled: PropTypes.bool.isRequired,
audioCaptionsActive: PropTypes.bool.isRequired,
audioCaptionsSet: PropTypes.func.isRequired,
isMobile: PropTypes.bool.isRequired,
optionsDropdownItems: PropTypes.arrayOf(PropTypes.shape({
id: PropTypes.string,
type: PropTypes.string,
})).isRequired,
};
const defaultProps = {
noIOSFullscreen: true,
amIModerator: false,
shortcuts: '',
isBreakoutRoom: false,
isDropdownOpen: false,
};
const ALLOW_FULLSCREEN = Meteor.settings.public.app.allowFullscreen;
const BBB_TABLET_APP_CONFIG = Meteor.settings.public.app.bbbTabletApp;
const { isSafari, isTabletApp } = browserInfo;
const FULLSCREEN_CHANGE_EVENT = isSafari ? 'webkitfullscreenchange' : 'fullscreenchange';
class OptionsDropdown extends PureComponent {
constructor(props) {
super(props);
this.state = {
isAboutModalOpen: false,
isShortcutHelpModalOpen: false,
isOptionsMenuModalOpen: false,
isEndMeetingConfirmationModalOpen: false,
isMobileAppModalOpen:false,
isFullscreen: false,
};
// Set the logout code to 680 because it's not a real code and can be matched on the other side
this.LOGOUT_CODE = '680';
this.leaveSession = this.leaveSession.bind(this);
this.onFullscreenChange = this.onFullscreenChange.bind(this);
this.setOptionsMenuModalIsOpen = this.setOptionsMenuModalIsOpen.bind(this);
this.setEndMeetingConfirmationModalIsOpen = this.setEndMeetingConfirmationModalIsOpen.bind(this);
this.setMobileAppModalIsOpen = this.setMobileAppModalIsOpen.bind(this);
this.setAboutModalIsOpen = this.setAboutModalIsOpen.bind(this);
this.setShortcutHelpModalIsOpen = this.setShortcutHelpModalIsOpen.bind(this);
}
componentDidMount() {
document.documentElement.addEventListener(FULLSCREEN_CHANGE_EVENT, this.onFullscreenChange);
}
componentWillUnmount() {
document.documentElement.removeEventListener(FULLSCREEN_CHANGE_EVENT, this.onFullscreenChange);
}
onFullscreenChange() {
const { isFullscreen } = this.state;
const newIsFullscreen = FullscreenService.isFullScreen(document.documentElement);
if (isFullscreen !== newIsFullscreen) {
this.setState({ isFullscreen: newIsFullscreen });
}
}
getFullscreenItem(menuItems) {
const {
intl,
noIOSFullscreen,
handleToggleFullscreen,
} = this.props;
const { isFullscreen } = this.state;
if (noIOSFullscreen || !ALLOW_FULLSCREEN) return null;
let fullscreenLabel = intl.formatMessage(intlMessages.fullscreenLabel);
let fullscreenDesc = intl.formatMessage(intlMessages.fullscreenDesc);
let fullscreenIcon = 'fullscreen';
if (isFullscreen) {
fullscreenLabel = intl.formatMessage(intlMessages.exitFullscreenLabel);
fullscreenDesc = intl.formatMessage(intlMessages.exitFullscreenDesc);
fullscreenIcon = 'exit_fullscreen';
}
return (
menuItems.push(
{
key: 'list-item-fullscreen',
icon: fullscreenIcon,
label: fullscreenLabel,
description: fullscreenDesc,
onClick: handleToggleFullscreen,
},
)
);
}
leaveSession() {
makeCall('userLeftMeeting');
// we don't check askForFeedbackOnLogout here,
// it is checked in meeting-ended component
Session.set('codeError', this.LOGOUT_CODE);
}
setAboutModalIsOpen(value) {
this.setState({isAboutModalOpen: value})
}
setShortcutHelpModalIsOpen(value) {
this.setState({isShortcutHelpModalOpen: value})
}
setOptionsMenuModalIsOpen(value) {
this.setState({isOptionsMenuModalOpen: value})
}
setEndMeetingConfirmationModalIsOpen(value) {
this.setState({isEndMeetingConfirmationModalOpen: value})
}
setMobileAppModalIsOpen(value) {
this.setState({isMobileAppModalOpen: value})
}
renderMenuItems() {
const {
intl, amIModerator, isBreakoutRoom, isMeteorConnected, audioCaptionsEnabled,
audioCaptionsActive, audioCaptionsSet, isMobile, optionsDropdownItems,
} = this.props;
const { isIos } = deviceInfo;
const allowedToEndMeeting = amIModerator && !isBreakoutRoom;
const {
showHelpButton: helpButton,
helpLink,
allowLogout: allowLogoutSetting,
} = Meteor.settings.public.app;
this.menuItems = [];
this.getFullscreenItem(this.menuItems);
this.menuItems.push(
{
key: 'list-item-settings',
icon: 'settings',
dataTest: 'settings',
label: intl.formatMessage(intlMessages.settingsLabel),
description: intl.formatMessage(intlMessages.settingsDesc),
onClick: () => this.setOptionsMenuModalIsOpen(true),
},
{
key: 'list-item-about',
icon: 'about',
dataTest: 'aboutModal',
label: intl.formatMessage(intlMessages.aboutLabel),
description: intl.formatMessage(intlMessages.aboutDesc),
onClick: () => this.setAboutModalIsOpen(true),
},
);
if (helpButton) {
this.menuItems.push(
{
key: 'list-item-help',
icon: 'help',
iconRight: 'popout_window',
label: intl.formatMessage(intlMessages.helpLabel),
dataTest: 'helpButton',
description: intl.formatMessage(intlMessages.helpDesc),
onClick: () => window.open(`${helpLink}`),
},
);
}
if (isIos &&
!isTabletApp &&
BBB_TABLET_APP_CONFIG.enabled == true &&
BBB_TABLET_APP_CONFIG.iosAppStoreUrl !== '') {
this.menuItems.push(
{
key: 'list-item-help',
icon: 'popout_window',
label: intl.formatMessage(intlMessages.openAppLabel),
onClick: () => this.setMobileAppModalIsOpen(true),
}
);
}
if (audioCaptionsEnabled && isMobile) {
this.menuItems.push(
{
key: 'audioCaptions',
dataTest: 'audioCaptions',
icon: audioCaptionsActive ? 'closed_caption_stop' : 'closed_caption',
label: intl.formatMessage(
audioCaptionsActive ? intlMessages.stopCaption : intlMessages.startCaption,
),
onClick: () => audioCaptionsSet(!audioCaptionsActive),
},
);
}
this.menuItems.push(
{
key: 'list-item-shortcuts',
icon: 'shortcuts',
label: intl.formatMessage(intlMessages.hotkeysLabel),
description: intl.formatMessage(intlMessages.hotkeysDesc),
onClick: () => this.setShortcutHelpModalIsOpen(true),
},
{
key: 'separator-01',
isSeparator: true,
},
);
optionsDropdownItems.forEach((item) => {
switch (item.type) {
case OptionsDropdownItemType.OPTION:
this.menuItems.push({
key: item.id,
icon: item.icon,
onClick: item.onClick,
label: item.label,
});
break;
case OptionsDropdownItemType.SEPARATOR:
this.menuItems.push({
key: item.id,
isSeparator: true,
});
break;
default:
break;
}
});
if (allowLogoutSetting && isMeteorConnected) {
this.menuItems.push(
{
key: 'list-item-logout',
dataTest: 'logout',
icon: 'logout',
label: intl.formatMessage(intlMessages.leaveSessionLabel),
description: intl.formatMessage(intlMessages.leaveSessionDesc),
onClick: () => this.leaveSession(),
},
);
}
if (allowedToEndMeeting && isMeteorConnected) {
const customStyles = { background: colorDanger, color: colorWhite };
this.menuItems.push(
{
key: 'list-item-end-meeting',
icon: 'application',
label: intl.formatMessage(intlMessages.endMeetingLabel),
description: intl.formatMessage(intlMessages.endMeetingDesc),
customStyles,
onClick: () => this.setEndMeetingConfirmationModalIsOpen(true),
},
);
}
return this.menuItems;
}
renderModal(isOpen, setIsOpen, priority, Component, otherOptions) {
return isOpen ? <Component
{...{
...otherOptions,
onRequestClose: () => setIsOpen(false),
priority,
setIsOpen,
isOpen
}}
/> : null
}
render() {
const {
intl,
shortcuts: OPEN_OPTIONS_AK,
isDropdownOpen,
isMobile,
isRTL,
} = this.props;
const { isAboutModalOpen, isShortcutHelpModalOpen, isOptionsMenuModalOpen,
isEndMeetingConfirmationModalOpen, isMobileAppModalOpen, } = this.state;
const customStyles = { top: '1rem' };
return (
<>
<BBBMenu
accessKey={OPEN_OPTIONS_AK}
customStyles={!isMobile ? customStyles : null}
trigger={(
<Styled.DropdownButton
state={isDropdownOpen ? 'open' : 'closed'}
label={intl.formatMessage(intlMessages.optionsLabel)}
icon="more"
data-test="optionsButton"
color="dark"
size="md"
circle
hideLabel
// FIXME: Without onClick react proptypes keep warning
// even after the DropdownTrigger inject an onClick handler
onClick={() => null}
/>
)}
actions={this.renderMenuItems()}
opts={{
id: 'app-settings-dropdown-menu',
keepMounted: true,
transitionDuration: 0,
elevation: 3,
getcontentanchorel: null,
fullwidth: 'true',
anchorOrigin: { vertical: 'bottom', horizontal: isRTL ? 'left' : 'right' },
transformorigin: { vertical: 'top', horizontal: isRTL ? 'left' : 'right' },
}}
/>
{this.renderModal(isAboutModalOpen, this.setAboutModalIsOpen, "low",
AboutContainer)}
{this.renderModal(isShortcutHelpModalOpen, this.setShortcutHelpModalIsOpen,
"low", ShortcutHelpComponent)}
{this.renderModal(isOptionsMenuModalOpen, this.setOptionsMenuModalIsOpen,
"low", OptionsMenuContainer)}
{this.renderModal(isEndMeetingConfirmationModalOpen, this.setEndMeetingConfirmationModalIsOpen,
"low", EndMeetingConfirmationContainer)}
{this.renderModal(isMobileAppModalOpen, this.setMobileAppModalIsOpen, "low",
MobileAppModal)}
</>
);
}
}
OptionsDropdown.propTypes = propTypes;
OptionsDropdown.defaultProps = defaultProps;
export default withShortcutHelper(injectIntl(OptionsDropdown), 'openOptions');