bigbluebutton-Github/bigbluebutton-html5/imports/ui/components/nav-bar/options-dropdown/component.jsx

551 lines
17 KiB
React
Raw Normal View History

import React, { PureComponent } from 'react';
import { defineMessages, injectIntl } from 'react-intl';
import PropTypes from 'prop-types';
2019-01-12 08:20:04 +08:00
import EndMeetingConfirmationContainer from '/imports/ui/components/end-meeting-confirmation/container';
2016-12-08 23:40:11 +08:00
import AboutContainer from '/imports/ui/components/about/container';
import MobileAppModal from '/imports/ui/components/mobile-app-modal/mobile-app-modal-graphql/component';
import LayoutModalContainer from '/imports/ui/components/layout/modal/container';
import OptionsMenuContainer from '/imports/ui/components/settings/container';
2022-02-15 23:38:55 +08:00
import BBBMenu from '/imports/ui/components/common/menu/component';
2018-04-27 01:24:25 +08:00
import ShortcutHelpComponent from '/imports/ui/components/shortcut-help/component';
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';
2021-12-10 22:55:37 +08:00
import Styled from './styles';
import browserInfo from '/imports/utils/browserInfo';
import deviceInfo from '/imports/utils/deviceInfo';
import Session from '/imports/ui/services/storage/in-memory';
import { LAYOUT_TYPE } from '/imports/ui/components/layout/enums';
import { getSettingsSingletonInstance } from '/imports/ui/services/settings';
import Toggle from '/imports/ui/components/common/switch/component';
2017-10-06 20:50:01 +08:00
2016-09-22 03:49:31 +08:00
const intlMessages = defineMessages({
optionsLabel: {
id: 'app.navBar.optionsDropdown.optionsLabel',
2017-04-10 23:50:03 +08:00
description: 'Options button label',
2016-09-22 03:49:31 +08:00
},
fullscreenLabel: {
id: 'app.navBar.optionsDropdown.fullscreenLabel',
2017-04-10 23:50:03 +08:00
description: 'Make fullscreen option label',
2016-09-22 03:49:31 +08:00
},
settingsLabel: {
id: 'app.navBar.optionsDropdown.settingsLabel',
2017-04-10 23:50:03 +08:00
description: 'Open settings option label',
2016-09-22 03:49:31 +08:00
},
2016-12-08 05:14:14 +08:00
aboutLabel: {
id: 'app.navBar.optionsDropdown.aboutLabel',
2017-04-10 23:50:03 +08:00
description: 'About option label',
2016-12-08 05:14:14 +08:00
},
aboutDesc: {
id: 'app.navBar.optionsDropdown.aboutDesc',
2017-04-10 23:50:03 +08:00
description: 'Describes about option',
2016-12-08 05:14:14 +08:00
},
2016-09-22 03:49:31 +08:00
leaveSessionLabel: {
id: 'app.navBar.optionsDropdown.leaveSessionLabel',
2017-04-10 23:50:03 +08:00
description: 'Leave session button label',
2016-09-22 03:49:31 +08:00
},
fullscreenDesc: {
id: 'app.navBar.optionsDropdown.fullscreenDesc',
2017-04-10 23:50:03 +08:00
description: 'Describes fullscreen option',
},
settingsDesc: {
id: 'app.navBar.optionsDropdown.settingsDesc',
2017-04-10 23:50:03 +08:00
description: 'Describes settings option',
},
leaveSessionDesc: {
id: 'app.navBar.optionsDropdown.leaveSessionDesc',
2017-04-10 23:50:03 +08:00
description: 'Describes leave session option',
},
2017-08-11 00:05:51 +08:00
exitFullscreenDesc: {
id: 'app.navBar.optionsDropdown.exitFullscreenDesc',
2017-04-10 23:50:03 +08:00
description: 'Describes exit fullscreen option',
2017-02-14 00:21:53 +08:00
},
2017-08-11 00:05:51 +08:00
exitFullscreenLabel: {
id: 'app.navBar.optionsDropdown.exitFullscreenLabel',
2017-04-10 23:50:03 +08:00
description: 'Exit fullscreen option label',
2017-02-14 00:21:53 +08:00
},
hotkeysLabel: {
id: 'app.navBar.optionsDropdown.hotkeysLabel',
2018-05-03 11:33:28 +08:00
description: 'Hotkeys options label',
},
hotkeysDesc: {
id: 'app.navBar.optionsDropdown.hotkeysDesc',
2018-05-03 11:33:28 +08:00
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',
},
2019-01-12 08:20:04 +08:00
endMeetingLabel: {
id: 'app.navBar.optionsDropdown.endMeetingForAllLabel',
2019-01-12 08:20:04 +08:00
description: 'End meeting options label',
},
endMeetingDesc: {
id: 'app.navBar.optionsDropdown.endMeetingDesc',
2019-01-12 08:20:04 +08:00
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',
},
layoutModal: {
id: 'app.actionsBar.actionsDropdown.layoutModal',
description: 'Label for layouts selection button',
},
awayLabel: {
id: 'app.actionsBar.reactions.away',
description: 'Away Label',
},
activeLabel: {
id: 'app.actionsBar.reactions.active',
description: 'Active Label',
},
2016-09-22 03:49:31 +08:00
});
const propTypes = {
2021-08-14 01:04:42 +08:00
intl: PropTypes.shape({
formatMessage: PropTypes.func.isRequired,
}).isRequired,
handleToggleFullscreen: PropTypes.func.isRequired,
noIOSFullscreen: PropTypes.bool,
amIModerator: PropTypes.bool,
shortcuts: PropTypes.string,
2019-05-14 22:28:18 +08:00
isBreakoutRoom: PropTypes.bool,
2019-06-27 00:29:34 +08:00
isMeteorConnected: PropTypes.bool.isRequired,
2021-08-14 01:04:42 +08:00
isDropdownOpen: PropTypes.bool,
audioCaptionsEnabled: PropTypes.bool,
audioCaptionsActive: PropTypes.bool.isRequired,
audioCaptionsSet: PropTypes.func.isRequired,
isMobile: PropTypes.bool.isRequired,
2023-11-21 00:30:07 +08:00
isDirectLeaveButtonEnabled: PropTypes.bool.isRequired,
optionsDropdownItems: PropTypes.arrayOf(PropTypes.shape({
id: PropTypes.string,
type: PropTypes.string,
})).isRequired,
2023-12-08 03:40:32 +08:00
userLeaveMeeting: PropTypes.func.isRequired,
};
const defaultProps = {
noIOSFullscreen: true,
amIModerator: false,
shortcuts: '',
2019-05-14 22:28:18 +08:00
isBreakoutRoom: false,
2021-08-14 01:04:42 +08:00
isDropdownOpen: false,
audioCaptionsEnabled: false,
};
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,
2023-11-21 00:30:07 +08:00
isMobileAppModalOpen: false,
2019-07-27 00:48:51 +08:00
isFullscreen: false,
isLayoutModalOpen: 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);
2019-07-27 00:48:51 +08:00
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);
this.setLayoutModalIsOpen = this.setLayoutModalIsOpen.bind(this);
2019-07-27 00:48:51 +08:00
}
componentDidMount() {
document.documentElement.addEventListener(FULLSCREEN_CHANGE_EVENT, this.onFullscreenChange);
2019-07-30 23:03:29 +08:00
}
componentWillUnmount() {
document.documentElement.removeEventListener(FULLSCREEN_CHANGE_EVENT, this.onFullscreenChange);
2017-12-16 14:41:54 +08:00
}
2019-07-27 00:48:51 +08:00
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;
2019-07-27 00:48:51 +08:00
const { isFullscreen } = this.state;
const ALLOW_FULLSCREEN = window.meetingClientSettings.public.app.allowFullscreen;
if (noIOSFullscreen || !ALLOW_FULLSCREEN) return null;
2018-05-09 05:37:58 +08:00
let fullscreenLabel = intl.formatMessage(intlMessages.fullscreenLabel);
let fullscreenDesc = intl.formatMessage(intlMessages.fullscreenDesc);
let fullscreenIcon = 'fullscreen';
2016-09-02 04:19:37 +08:00
if (isFullscreen) {
fullscreenLabel = intl.formatMessage(intlMessages.exitFullscreenLabel);
fullscreenDesc = intl.formatMessage(intlMessages.exitFullscreenDesc);
fullscreenIcon = 'exit_fullscreen';
}
2018-05-09 05:37:58 +08:00
return (
menuItems.push(
{
2021-08-14 01:04:42 +08:00
key: 'list-item-fullscreen',
icon: fullscreenIcon,
label: fullscreenLabel,
description: fullscreenDesc,
2024-10-10 01:23:06 +08:00
onClick: () => handleToggleFullscreen(),
2021-08-14 01:04:42 +08:00
},
)
2018-12-06 01:42:31 +08:00
);
}
2019-05-25 05:26:00 +08:00
leaveSession() {
2023-12-08 03:40:32 +08:00
const { userLeaveMeeting } = this.props;
userLeaveMeeting();
2019-05-25 05:26:00 +08:00
// we don't check askForFeedbackOnLogout here,
// it is checked in meeting-ended component
Session.setItem('codeError', this.LOGOUT_CODE);
2019-05-25 05:26:00 +08:00
}
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})
}
setLayoutModalIsOpen(value) {
this.setState({ isLayoutModalOpen: value });
}
renderMenuItems() {
const {
intl, amIModerator, isBreakoutRoom, isMeteorConnected, audioCaptionsEnabled,
audioCaptionsActive, audioCaptionsSet, isMobile, optionsDropdownItems,
isDirectLeaveButtonEnabled, isLayoutsEnabled, away, handleToggleAFK,
} = this.props;
const { isIos } = deviceInfo;
2019-05-14 22:28:18 +08:00
const allowedToEndMeeting = amIModerator && !isBreakoutRoom;
const {
showHelpButton: helpButton,
helpLink,
allowLogout: allowLogoutSetting,
} = window.meetingClientSettings.public.app;
this.menuItems = [];
const actionCustomStyles = {
paddingLeft: 0,
paddingRight: 0,
paddingTop: isMobile ? '0' : '0.5rem',
paddingBottom: isMobile ? '0' : '0.5rem',
};
const ToggleAFKLabel = () => (away
? intl.formatMessage(intlMessages.awayLabel)
: intl.formatMessage(intlMessages.activeLabel));
this.menuItems.push({
label: (
<Styled.AwayOption>
<>Presence</>
<Styled.ToggleButtonWrapper>
<Styled.AFKLabel>{ToggleAFKLabel()}</Styled.AFKLabel>
<Toggle
icons={false}
checked={away}
onChange={handleToggleAFK}
ariaLabel={ToggleAFKLabel()}
showToggleLabel={false}
invertColors
/>
</Styled.ToggleButtonWrapper>
</Styled.AwayOption>
),
key: 'none',
isToggle: true,
customStyles: { ...actionCustomStyles, width: 'auto' },
}, {
key: 'separator-01',
isSeparator: true,
});
2021-08-14 01:04:42 +08:00
this.getFullscreenItem(this.menuItems);
const BBB_TABLET_APP_CONFIG = window.meetingClientSettings.public.app.bbbTabletApp;
this.menuItems.push(
{
2021-08-14 01:04:42 +08:00
key: 'list-item-settings',
icon: 'settings',
dataTest: 'settings',
label: intl.formatMessage(intlMessages.settingsLabel),
description: intl.formatMessage(intlMessages.settingsDesc),
onClick: () => this.setOptionsMenuModalIsOpen(true),
},
{
2021-08-14 01:04:42 +08:00
key: 'list-item-about',
icon: 'about',
dataTest: 'aboutModal',
label: intl.formatMessage(intlMessages.aboutLabel),
description: intl.formatMessage(intlMessages.aboutDesc),
onClick: () => this.setAboutModalIsOpen(true),
2021-08-14 01:04:42 +08:00
},
);
2021-08-14 00:53:04 +08:00
if (helpButton) {
this.menuItems.push(
{
2021-08-14 01:04:42 +08:00
key: 'list-item-help',
icon: 'help',
iconRight: 'popout_window',
label: intl.formatMessage(intlMessages.helpLabel),
2022-09-07 00:52:45 +08:00
dataTest: 'helpButton',
description: intl.formatMessage(intlMessages.helpDesc),
2021-08-14 01:04:42 +08:00
onClick: () => window.open(`${helpLink}`),
},
);
}
2021-08-14 01:04:42 +08:00
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(
{
2021-08-14 01:04:42 +08:00
key: 'list-item-shortcuts',
icon: 'shortcuts',
label: intl.formatMessage(intlMessages.hotkeysLabel),
description: intl.formatMessage(intlMessages.hotkeysDesc),
onClick: () => this.setShortcutHelpModalIsOpen(true),
},
);
const Settings = getSettingsSingletonInstance();
const { selectedLayout } = Settings.application;
const shouldShowManageLayoutButton = selectedLayout !== LAYOUT_TYPE.CAMERAS_ONLY
&& selectedLayout !== LAYOUT_TYPE.PRESENTATION_ONLY
&& selectedLayout !== LAYOUT_TYPE.PARTICIPANTS_AND_CHAT_ONLY;
if (shouldShowManageLayoutButton && isLayoutsEnabled) {
this.menuItems.push(
{
key: 'list-item-layout-modal',
icon: 'manage_layout',
label: intl.formatMessage(intlMessages.layoutModal),
onClick: () => this.setLayoutModalIsOpen(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 (isMeteorConnected && !isDirectLeaveButtonEnabled) {
const bottomItems = [{
key: 'list-item-separator',
isSeparator: true,
}];
if (allowLogoutSetting) {
bottomItems.push({
key: 'list-item-logout',
2024-03-02 00:44:46 +08:00
dataTest: 'optionsLogoutButton',
icon: 'logout',
label: intl.formatMessage(intlMessages.leaveSessionLabel),
description: intl.formatMessage(intlMessages.leaveSessionDesc),
onClick: () => this.leaveSession(),
});
}
if (allowedToEndMeeting) {
const customStyles = { background: colorDanger, color: colorWhite };
bottomItems.push({
key: 'list-item-end-meeting',
icon: 'close',
label: intl.formatMessage(intlMessages.endMeetingLabel),
description: intl.formatMessage(intlMessages.endMeetingDesc),
customStyles,
onClick: () => this.setEndMeetingConfirmationModalIsOpen(true),
});
}
if (bottomItems.length > 1) this.menuItems.push(...bottomItems);
2021-08-14 00:53:04 +08:00
}
return this.menuItems;
2017-12-16 14:41:54 +08:00
}
2017-02-14 00:21:53 +08:00
renderModal(isOpen, setIsOpen, priority, Component, otherOptions) {
return isOpen ? <Component
{...{
...otherOptions,
onRequestClose: () => setIsOpen(false),
priority,
setIsOpen,
isOpen
}}
/> : null
}
2017-12-16 14:41:54 +08:00
render() {
const {
intl,
shortcuts: OPEN_OPTIONS_AK,
isDropdownOpen,
isMobile,
2022-05-13 21:42:19 +08:00
isRTL,
} = this.props;
2017-02-14 00:21:53 +08:00
const {
isAboutModalOpen, isShortcutHelpModalOpen, isOptionsMenuModalOpen,
isEndMeetingConfirmationModalOpen, isMobileAppModalOpen, isLayoutModalOpen,
} = this.state;
2022-05-13 21:42:19 +08:00
const customStyles = { top: '1rem' };
2021-08-14 01:04:42 +08:00
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,
2023-05-10 09:31:48 +08:00
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)}
{this.renderModal(
isLayoutModalOpen,
this.setLayoutModalIsOpen,
'low',
LayoutModalContainer,
)}
</>
2016-09-02 04:19:37 +08:00
);
}
}
OptionsDropdown.propTypes = propTypes;
OptionsDropdown.defaultProps = defaultProps;
2024-04-25 04:18:21 +08:00
export default injectIntl(OptionsDropdown);