gecko-dev/browser/components/loop/standalone/content/js/standaloneRoomViews.js

732 lines
25 KiB
JavaScript

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
var loop = loop || {};
loop.standaloneRoomViews = (function(mozL10n) {
"use strict";
var FAILURE_DETAILS = loop.shared.utils.FAILURE_DETAILS;
var ROOM_INFO_FAILURES = loop.shared.utils.ROOM_INFO_FAILURES;
var ROOM_STATES = loop.store.ROOM_STATES;
var sharedActions = loop.shared.actions;
var sharedMixins = loop.shared.mixins;
var sharedUtils = loop.shared.utils;
var sharedViews = loop.shared.views;
var ToSView = React.createClass({displayName: "ToSView",
propTypes: {
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired
},
_getContent: function() {
// We use this technique of static markup as it means we get
// just one overall string for L10n to define the structure of
// the whole item.
return mozL10n.get("legal_text_and_links", {
"clientShortname": mozL10n.get("clientShortname2"),
"terms_of_use_url": React.renderToStaticMarkup(
React.createElement("a", {href: loop.config.legalWebsiteUrl, rel: "noreferrer", target: "_blank"},
mozL10n.get("terms_of_use_link_text")
)
),
"privacy_notice_url": React.renderToStaticMarkup(
React.createElement("a", {href: loop.config.privacyWebsiteUrl, rel: "noreferrer", target: "_blank"},
mozL10n.get("privacy_notice_link_text")
)
)
});
},
recordClick: function(event) {
// Check for valid href, as this is clicking on the paragraph -
// so the user may be clicking on the text rather than the link.
if (event.target && event.target.href) {
this.props.dispatcher.dispatch(new sharedActions.RecordClick({
linkInfo: event.target.href
}));
}
},
render: function() {
return (
React.createElement("p", {
className: "terms-service",
dangerouslySetInnerHTML: {__html: this._getContent()},
onClick: this.recordClick})
);
}
});
var StandaloneHandleUserAgentView = React.createClass({displayName: "StandaloneHandleUserAgentView",
mixins: [
loop.store.StoreMixin("activeRoomStore")
],
propTypes: {
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired
},
getInitialState: function() {
return this.getStoreState();
},
handleJoinButton: function() {
this.props.dispatcher.dispatch(new sharedActions.JoinRoom());
},
_renderJoinButton: function() {
var buttonMessage = this.state.roomState === ROOM_STATES.JOINED ?
mozL10n.get("rooms_room_joined_own_conversation_label") :
mozL10n.get("rooms_room_join_label");
var buttonClasses = React.addons.classSet({
btn: true,
"btn-info": true,
disabled: this.state.roomState === ROOM_STATES.JOINED
});
return (
React.createElement("button", {
className: buttonClasses,
onClick: this.handleJoinButton},
buttonMessage
)
);
},
_renderFailureText: function() {
return (
React.createElement("p", {className: "failure"}, mozL10n.get("rooms_already_joined") )
);
},
render: function() {
// The extra scroller div here is for providing a scroll view for shorter
// screens, as the common.css specifies overflow:hidden for the body which
// we need in some places.
return (
React.createElement("div", {className: "handle-user-agent-view-scroller"},
React.createElement("div", {className: "handle-user-agent-view"},
React.createElement("div", {className: "info-panel"},
React.createElement("p", {className: "loop-logo-text", title: mozL10n.get("clientShortname2") }),
React.createElement("p", {className: "roomName"}, this.state.roomName),
React.createElement("p", {className: "loop-logo"}),
this.state.failureReason ?
this._renderFailureText() :
this._renderJoinButton()
),
React.createElement(ToSView, {dispatcher: this.props.dispatcher}),
React.createElement("p", {className: "mozilla-logo"})
)
)
);
}
});
/**
* Handles display of failures, determining the correct messages and
* displaying the retry button at appropriate times.
*/
var StandaloneRoomFailureView = React.createClass({displayName: "StandaloneRoomFailureView",
propTypes: {
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired,
// One of FAILURE_DETAILS.
failureReason: React.PropTypes.string
},
/**
* Handles when the retry button is pressed.
*/
handleRetryButton: function() {
this.props.dispatcher.dispatch(new sharedActions.RetryAfterRoomFailure());
},
/**
* @return String An appropriate string according to the failureReason.
*/
getFailureString: function() {
switch(this.props.failureReason) {
case FAILURE_DETAILS.MEDIA_DENIED:
// XXX Bug 1166824 should provide a better string for this.
case FAILURE_DETAILS.NO_MEDIA:
return mozL10n.get("rooms_media_denied_message");
case FAILURE_DETAILS.EXPIRED_OR_INVALID:
return mozL10n.get("rooms_unavailable_notification_message");
case FAILURE_DETAILS.TOS_FAILURE:
return mozL10n.get("tos_failure_message",
{ clientShortname: mozL10n.get("clientShortname2") });
case FAILURE_DETAILS.ICE_FAILED:
return mozL10n.get("rooms_ice_failure_message");
default:
return mozL10n.get("status_error");
}
},
/**
* This renders a retry button if one is necessary.
*/
renderRetryButton: function() {
if (this.props.failureReason === FAILURE_DETAILS.EXPIRED_OR_INVALID ||
this.props.failureReason === FAILURE_DETAILS.TOS_FAILURE) {
return null;
}
return (
React.createElement("button", {className: "btn btn-join btn-info",
onClick: this.handleRetryButton},
mozL10n.get("retry_call_button")
)
);
},
render: function() {
return (
React.createElement("div", {className: "room-inner-info-area"},
React.createElement("p", {className: "failed-room-message"},
this.getFailureString()
),
this.renderRetryButton()
)
);
}
});
var StandaloneRoomInfoArea = React.createClass({displayName: "StandaloneRoomInfoArea",
statics: {
RENDER_WAITING_DELAY: 2000
},
propTypes: {
activeRoomStore: React.PropTypes.instanceOf(loop.store.ActiveRoomStore).isRequired,
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired,
failureReason: React.PropTypes.string,
isFirefox: React.PropTypes.bool.isRequired,
joinRoom: React.PropTypes.func.isRequired,
roomState: React.PropTypes.string.isRequired,
roomUsed: React.PropTypes.bool.isRequired
},
getInitialState: function() {
return { waitToRenderWaiting: true };
},
componentDidMount: function() {
// Watch for messages from the waiting-tile iframe
window.addEventListener("message", this.recordTileClick);
},
/**
* Change state to allow for the waiting message to be shown and send an
* event to record that fact.
*/
_allowRenderWaiting: function() {
delete this._waitTimer;
// Only update state if we're still showing a waiting message.
switch (this.props.roomState) {
case ROOM_STATES.JOINING:
case ROOM_STATES.JOINED:
case ROOM_STATES.SESSION_CONNECTED:
this.setState({ waitToRenderWaiting: false });
this.props.dispatcher.dispatch(new sharedActions.TileShown());
break;
}
},
componentDidUpdate: function() {
// Start a timer once from the earliest waiting state or from the state
// after someone else leaves if we need to wait before showing a message.
if ((this.props.roomState === ROOM_STATES.JOINING ||
this.props.roomState === ROOM_STATES.SESSION_CONNECTED) &&
this.state.waitToRenderWaiting &&
this._waitTimer === undefined) {
this._waitTimer = setTimeout(this._allowRenderWaiting,
this.constructor.RENDER_WAITING_DELAY);
}
},
componentWillReceiveProps: function(nextProps) {
switch (nextProps.roomState) {
// Reset waiting for the next time the user joins.
case ROOM_STATES.ENDED:
case ROOM_STATES.READY:
if (!this.state.waitToRenderWaiting) {
this.setState({ waitToRenderWaiting: true });
}
if (this._waitTimer !== undefined) {
clearTimeout(this._waitTimer);
delete this._waitTimer;
}
break;
}
},
componentWillUnmount: function() {
window.removeEventListener("message", this.recordTileClick);
},
recordTileClick: function(event) {
if (event.data === "tile-click") {
this.props.dispatcher.dispatch(new sharedActions.RecordClick({
linkInfo: "Tiles iframe click"
}));
}
},
recordTilesSupport: function() {
this.props.dispatcher.dispatch(new sharedActions.RecordClick({
linkInfo: "Tiles support link click"
}));
},
_renderCallToActionLink: function() {
if (this.props.isFirefox) {
return (
React.createElement("a", {className: "btn btn-info", href: loop.config.learnMoreUrl},
mozL10n.get("rooms_room_full_call_to_action_label", {
clientShortname: mozL10n.get("clientShortname2")
})
)
);
}
return (
React.createElement("a", {className: "btn btn-info", href: loop.config.downloadFirefoxUrl},
mozL10n.get("rooms_room_full_call_to_action_nonFx_label", {
brandShortname: mozL10n.get("brandShortname")
})
)
);
},
render: function() {
switch(this.props.roomState) {
case ROOM_STATES.ENDED:
case ROOM_STATES.READY: {
return (
React.createElement("div", {className: "room-inner-info-area"},
React.createElement("button", {className: "btn btn-join btn-info",
onClick: this.props.joinRoom},
mozL10n.get("rooms_room_join_label")
),
React.createElement(ToSView, {dispatcher: this.props.dispatcher})
)
);
}
case ROOM_STATES.MEDIA_WAIT: {
var msg = mozL10n.get("call_progress_getting_media_description",
{clientShortname: mozL10n.get("clientShortname2")});
var utils = loop.shared.utils;
var isChrome = utils.isChrome(navigator.userAgent);
var isFirefox = utils.isFirefox(navigator.userAgent);
var isOpera = utils.isOpera(navigator.userAgent);
var promptMediaMessageClasses = React.addons.classSet({
"prompt-media-message": true,
"chrome": isChrome,
"firefox": isFirefox,
"opera": isOpera,
"other": !isChrome && !isFirefox && !isOpera
});
return (
React.createElement("div", {className: "room-inner-info-area"},
React.createElement("p", {className: promptMediaMessageClasses},
msg
)
)
);
}
case ROOM_STATES.JOINING:
case ROOM_STATES.JOINED:
case ROOM_STATES.SESSION_CONNECTED: {
// Don't show the waiting display until after a brief wait in case
// there's another participant that will momentarily appear.
if (this.state.waitToRenderWaiting) {
return null;
}
return (
React.createElement("div", {className: "room-inner-info-area"},
React.createElement("p", {className: "empty-room-message"},
mozL10n.get("rooms_only_occupant_label2")
),
React.createElement("p", {className: "room-waiting-area"},
mozL10n.get("rooms_read_while_wait_offer"),
React.createElement("a", {href: loop.config.tilesSupportUrl,
onClick: this.recordTilesSupport,
rel: "noreferrer",
target: "_blank"},
React.createElement("i", {className: "room-waiting-help"})
)
),
React.createElement("iframe", {className: "room-waiting-tile", src: loop.config.tilesIframeUrl})
)
);
}
case ROOM_STATES.FULL: {
return (
React.createElement("div", {className: "room-inner-info-area"},
React.createElement("p", {className: "full-room-message"},
mozL10n.get("rooms_room_full_label")
),
React.createElement("p", null, this._renderCallToActionLink())
)
);
}
case ROOM_STATES.FAILED: {
return (
React.createElement(StandaloneRoomFailureView, {
dispatcher: this.props.dispatcher,
failureReason: this.props.failureReason})
);
}
case ROOM_STATES.INIT:
case ROOM_STATES.GATHER:
default: {
return null;
}
}
}
});
var StandaloneRoomHeader = React.createClass({displayName: "StandaloneRoomHeader",
propTypes: {
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired
},
recordClick: function() {
this.props.dispatcher.dispatch(new sharedActions.RecordClick({
linkInfo: "Support link click"
}));
},
render: function() {
return (
React.createElement("header", null,
React.createElement("h1", null, mozL10n.get("clientShortname2")),
React.createElement("a", {href: loop.config.generalSupportUrl,
onClick: this.recordClick,
rel: "noreferrer",
target: "_blank"},
React.createElement("i", {className: "icon icon-help"})
)
)
);
}
});
var StandaloneRoomView = React.createClass({displayName: "StandaloneRoomView",
mixins: [
Backbone.Events,
sharedMixins.MediaSetupMixin,
sharedMixins.RoomsAudioMixin,
sharedMixins.DocumentTitleMixin
],
propTypes: {
// We pass conversationStore here rather than use the mixin, to allow
// easy configurability for the ui-showcase.
activeRoomStore: React.PropTypes.instanceOf(loop.store.ActiveRoomStore).isRequired,
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired,
isFirefox: React.PropTypes.bool.isRequired,
// The poster URLs are for UI-showcase testing and development
localPosterUrl: React.PropTypes.string,
remotePosterUrl: React.PropTypes.string,
roomState: React.PropTypes.string,
screenSharePosterUrl: React.PropTypes.string
},
getInitialState: function() {
var storeState = this.props.activeRoomStore.getStoreState();
return _.extend({}, storeState, {
// Used by the UI showcase.
roomState: this.props.roomState || storeState.roomState
});
},
componentWillMount: function() {
this.props.activeRoomStore.on("change", function() {
this.setState(this.props.activeRoomStore.getStoreState());
}, this);
},
componentWillUnmount: function() {
this.props.activeRoomStore.off("change", null, this);
},
componentDidMount: function() {
// Adding a class to the document body element from here to ease styling it.
document.body.classList.add("is-standalone-room");
},
/**
* Watches for when we transition to MEDIA_WAIT room state, so we can request
* user media access.
*
* @param {Object} nextProps (Unused)
* @param {Object} nextState Next state object.
*/
componentWillUpdate: function(nextProps, nextState) {
if (this.state.roomState !== ROOM_STATES.READY &&
nextState.roomState === ROOM_STATES.READY) {
var roomName = nextState.roomName || this.state.roomName;
if (roomName) {
this.setTitle(mozL10n.get("standalone_title_with_room_name", {
roomName: roomName,
clientShortname: mozL10n.get("clientShortname2")
}));
} else {
this.setTitle(mozL10n.get("clientShortname2"));
}
}
if (this.state.roomState !== ROOM_STATES.MEDIA_WAIT &&
nextState.roomState === ROOM_STATES.MEDIA_WAIT) {
this.props.dispatcher.dispatch(new sharedActions.SetupStreamElements({
publisherConfig: this.getDefaultPublisherConfig({publishVideo: true})
}));
}
// UX don't want to surface these errors (as they would imply the user
// needs to do something to fix them, when if they're having a conversation
// they just need to connect). However, we do want there to be somewhere to
// find reasonably easily, in case there's issues raised.
if (!this.state.roomInfoFailure && nextState.roomInfoFailure) {
if (nextState.roomInfoFailure === ROOM_INFO_FAILURES.WEB_CRYPTO_UNSUPPORTED) {
console.error(mozL10n.get("room_information_failure_unsupported_browser"));
} else {
console.error(mozL10n.get("room_information_failure_not_available"));
}
}
},
joinRoom: function() {
this.props.dispatcher.dispatch(new sharedActions.JoinRoom());
},
leaveRoom: function() {
this.props.dispatcher.dispatch(new sharedActions.LeaveRoom());
},
/**
* Toggles streaming status for a given stream type.
*
* @param {String} type Stream type ("audio" or "video").
* @param {Boolean} enabled Enabled stream flag.
*/
publishStream: function(type, enabled) {
this.props.dispatcher.dispatch(new sharedActions.SetMute({
type: type,
enabled: enabled
}));
},
/**
* Checks if current room is active.
*
* @return {Boolean}
*/
_roomIsActive: function() {
return this.state.roomState === ROOM_STATES.JOINED ||
this.state.roomState === ROOM_STATES.SESSION_CONNECTED ||
this.state.roomState === ROOM_STATES.HAS_PARTICIPANTS;
},
/**
* Works out if remote video should be rended or not, depending on the
* room state and other flags.
*
* @return {Boolean} True if remote video should be rended.
*
* XXX Refactor shouldRenderRemoteVideo & shouldRenderLoading to remove
* overlapping cases.
*/
shouldRenderRemoteVideo: function() {
switch(this.state.roomState) {
case ROOM_STATES.HAS_PARTICIPANTS:
if (this.state.remoteVideoEnabled) {
return true;
}
if (this.state.mediaConnected) {
// since the remoteVideo hasn't yet been enabled, if the
// media is connected, then we should be displaying an avatar.
return false;
}
return true;
case ROOM_STATES.READY:
case ROOM_STATES.GATHER:
case ROOM_STATES.INIT:
case ROOM_STATES.JOINING:
case ROOM_STATES.SESSION_CONNECTED:
case ROOM_STATES.JOINED:
case ROOM_STATES.MEDIA_WAIT:
// this case is so that we don't show an avatar while waiting for
// the other party to connect
return true;
case ROOM_STATES.FAILED:
case ROOM_STATES.CLOSING:
case ROOM_STATES.FULL:
case ROOM_STATES.ENDED:
// the other person has shown up, so we don't want to show an avatar
return true;
default:
console.warn("StandaloneRoomView.shouldRenderRemoteVideo:" +
" unexpected roomState: ", this.state.roomState);
return true;
}
},
/**
* Should we render a visual cue to the user (e.g. a spinner) that a local
* stream is on its way from the camera?
*
* @returns {boolean}
* @private
*/
_isLocalLoading: function () {
return this.state.roomState === ROOM_STATES.MEDIA_WAIT &&
!this.state.localSrcMediaElement;
},
/**
* Should we render a visual cue to the user (e.g. a spinner) that a remote
* stream is on its way from the other user?
*
* @returns {boolean}
* @private
*/
_isRemoteLoading: function() {
return !!(this.state.roomState === ROOM_STATES.HAS_PARTICIPANTS &&
!this.state.remoteSrcMediaElement &&
!this.state.mediaConnected);
},
/**
* Should we render a visual cue to the user (e.g. a spinner) that a remote
* screen-share is on its way from the other user?
*
* @returns {boolean}
* @private
*/
_isScreenShareLoading: function() {
return this.state.receivingScreenShare &&
!this.state.screenShareMediaElement &&
!this.props.screenSharePosterUrl;
},
render: function() {
var displayScreenShare = !!(this.state.receivingScreenShare ||
this.props.screenSharePosterUrl);
return (
React.createElement("div", {className: "room-conversation-wrapper standalone-room-wrapper"},
React.createElement("div", {className: "beta-logo"}),
React.createElement(StandaloneRoomHeader, {dispatcher: this.props.dispatcher}),
React.createElement(sharedViews.MediaLayoutView, {
dispatcher: this.props.dispatcher,
displayScreenShare: displayScreenShare,
isLocalLoading: this._isLocalLoading(),
isRemoteLoading: this._isRemoteLoading(),
isScreenShareLoading: this._isScreenShareLoading(),
localPosterUrl: this.props.localPosterUrl,
localSrcMediaElement: this.state.localSrcMediaElement,
localVideoMuted: this.state.videoMuted,
matchMedia: this.state.matchMedia || window.matchMedia.bind(window),
remotePosterUrl: this.props.remotePosterUrl,
remoteSrcMediaElement: this.state.remoteSrcMediaElement,
renderRemoteVideo: this.shouldRenderRemoteVideo(),
screenShareMediaElement: this.state.screenShareMediaElement,
screenSharePosterUrl: this.props.screenSharePosterUrl,
showContextRoomName: true,
useDesktopPaths: false},
React.createElement(StandaloneRoomInfoArea, {activeRoomStore: this.props.activeRoomStore,
dispatcher: this.props.dispatcher,
failureReason: this.state.failureReason,
isFirefox: this.props.isFirefox,
joinRoom: this.joinRoom,
roomState: this.state.roomState,
roomUsed: this.state.used}),
React.createElement(sharedViews.ConversationToolbar, {
audio: {enabled: !this.state.audioMuted,
visible: this._roomIsActive()},
dispatcher: this.props.dispatcher,
enableHangup: this._roomIsActive(),
hangup: this.leaveRoom,
hangupButtonLabel: mozL10n.get("rooms_leave_button_label"),
publishStream: this.publishStream,
show: true,
video: {enabled: !this.state.videoMuted,
visible: this._roomIsActive()}}),
React.createElement(StandaloneMozLogo, {dispatcher: this.props.dispatcher})
)
)
);
}
});
var StandaloneMozLogo = React.createClass({displayName: "StandaloneMozLogo",
propTypes: {
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired
},
render: function() {
return (
React.createElement("div", {className: "standalone-moz-logo"})
);
}
});
var StandaloneRoomControllerView = React.createClass({displayName: "StandaloneRoomControllerView",
mixins: [
loop.store.StoreMixin("activeRoomStore")
],
propTypes: {
dispatcher: React.PropTypes.instanceOf(loop.Dispatcher).isRequired,
isFirefox: React.PropTypes.bool.isRequired
},
getInitialState: function() {
return this.getStoreState();
},
render: function() {
// If we don't know yet, don't display anything.
if (this.state.userAgentHandlesRoom === undefined) {
return null;
}
if (this.state.userAgentHandlesRoom) {
return (
React.createElement(StandaloneHandleUserAgentView, {
dispatcher: this.props.dispatcher})
);
}
return (
React.createElement(StandaloneRoomView, {
activeRoomStore: this.getStore(),
dispatcher: this.props.dispatcher,
isFirefox: this.props.isFirefox})
);
}
});
return {
StandaloneHandleUserAgentView: StandaloneHandleUserAgentView,
StandaloneRoomControllerView: StandaloneRoomControllerView,
StandaloneRoomFailureView: StandaloneRoomFailureView,
StandaloneRoomHeader: StandaloneRoomHeader,
StandaloneRoomInfoArea: StandaloneRoomInfoArea,
StandaloneRoomView: StandaloneRoomView,
ToSView: ToSView
};
})(navigator.mozL10n);