forked from mirrors/gecko-dev
406 lines
12 KiB
JavaScript
406 lines
12 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/. */
|
|
|
|
/* global loop:true */
|
|
|
|
var loop = loop || {};
|
|
loop.store = loop.store || {};
|
|
|
|
loop.store.ConversationStore = (function() {
|
|
var sharedActions = loop.shared.actions;
|
|
var CALL_TYPES = loop.shared.utils.CALL_TYPES;
|
|
|
|
/**
|
|
* Websocket states taken from:
|
|
* https://docs.services.mozilla.com/loop/apis.html#call-progress-state-change-progress
|
|
*/
|
|
var WS_STATES = loop.store.WS_STATES = {
|
|
// The call is starting, and the remote party is not yet being alerted.
|
|
INIT: "init",
|
|
// The called party is being alerted.
|
|
ALERTING: "alerting",
|
|
// The call is no longer being set up and has been aborted for some reason.
|
|
TERMINATED: "terminated",
|
|
// The called party has indicated that he has answered the call,
|
|
// but the media is not yet confirmed.
|
|
CONNECTING: "connecting",
|
|
// One of the two parties has indicated successful media set up,
|
|
// but the other has not yet.
|
|
HALF_CONNECTED: "half-connected",
|
|
// Both endpoints have reported successfully establishing media.
|
|
CONNECTED: "connected"
|
|
};
|
|
|
|
var CALL_STATES = loop.store.CALL_STATES = {
|
|
// The initial state of the view.
|
|
INIT: "cs-init",
|
|
// The store is gathering the call data from the server.
|
|
GATHER: "cs-gather",
|
|
// The initial data has been gathered, the websocket is connecting, or has
|
|
// connected, and waiting for the other side to connect to the server.
|
|
CONNECTING: "cs-connecting",
|
|
// The websocket has received information that we're now alerting
|
|
// the peer.
|
|
ALERTING: "cs-alerting",
|
|
// The call is ongoing.
|
|
ONGOING: "cs-ongoing",
|
|
// The call ended successfully.
|
|
FINISHED: "cs-finished",
|
|
// The user has finished with the window.
|
|
CLOSE: "cs-close",
|
|
// The call was terminated due to an issue during connection.
|
|
TERMINATED: "cs-terminated"
|
|
};
|
|
|
|
var ConversationStore = Backbone.Model.extend({
|
|
defaults: {
|
|
// The current state of the call
|
|
callState: CALL_STATES.INIT,
|
|
// The reason if a call was terminated
|
|
callStateReason: undefined,
|
|
// The error information, if there was a failure
|
|
error: undefined,
|
|
// True if the call is outgoing, false if not, undefined if unknown
|
|
outgoing: undefined,
|
|
// The contact being called for outgoing calls
|
|
contact: undefined,
|
|
// The call type for the call.
|
|
// XXX Don't hard-code, this comes from the data in bug 1072323
|
|
callType: CALL_TYPES.AUDIO_VIDEO,
|
|
|
|
// Call Connection information
|
|
// The call id from the loop-server
|
|
callId: undefined,
|
|
// The connection progress url to connect the websocket
|
|
progressURL: undefined,
|
|
// The websocket token that allows connection to the progress url
|
|
websocketToken: undefined,
|
|
// SDK API key
|
|
apiKey: undefined,
|
|
// SDK session ID
|
|
sessionId: undefined,
|
|
// SDK session token
|
|
sessionToken: undefined,
|
|
// If the audio is muted
|
|
audioMuted: false,
|
|
// If the video is muted
|
|
videoMuted: false
|
|
},
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* Options:
|
|
* - {loop.Dispatcher} dispatcher The dispatcher for dispatching actions and
|
|
* registering to consume actions.
|
|
* - {Object} client A client object for communicating with the server.
|
|
*
|
|
* @param {Object} attributes Attributes object.
|
|
* @param {Object} options Options object.
|
|
*/
|
|
initialize: function(attributes, options) {
|
|
options = options || {};
|
|
|
|
if (!options.dispatcher) {
|
|
throw new Error("Missing option dispatcher");
|
|
}
|
|
if (!options.client) {
|
|
throw new Error("Missing option client");
|
|
}
|
|
if (!options.sdkDriver) {
|
|
throw new Error("Missing option sdkDriver");
|
|
}
|
|
|
|
this.client = options.client;
|
|
this.dispatcher = options.dispatcher;
|
|
this.sdkDriver = options.sdkDriver;
|
|
|
|
this.dispatcher.register(this, [
|
|
"connectionFailure",
|
|
"connectionProgress",
|
|
"gatherCallData",
|
|
"connectCall",
|
|
"hangupCall",
|
|
"peerHungupCall",
|
|
"cancelCall",
|
|
"retryCall",
|
|
"mediaConnected",
|
|
"setMute"
|
|
]);
|
|
},
|
|
|
|
/**
|
|
* Handles the connection failure action, setting the state to
|
|
* terminated.
|
|
*
|
|
* @param {sharedActions.ConnectionFailure} actionData The action data.
|
|
*/
|
|
connectionFailure: function(actionData) {
|
|
this._endSession();
|
|
this.set({
|
|
callState: CALL_STATES.TERMINATED,
|
|
callStateReason: actionData.reason
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Handles the connection progress action, setting the next state
|
|
* appropriately.
|
|
*
|
|
* @param {sharedActions.ConnectionProgress} actionData The action data.
|
|
*/
|
|
connectionProgress: function(actionData) {
|
|
var callState = this.get("callState");
|
|
|
|
switch(actionData.wsState) {
|
|
case WS_STATES.INIT: {
|
|
if (callState === CALL_STATES.GATHER) {
|
|
this.set({callState: CALL_STATES.CONNECTING});
|
|
}
|
|
break;
|
|
}
|
|
case WS_STATES.ALERTING: {
|
|
this.set({callState: CALL_STATES.ALERTING});
|
|
break;
|
|
}
|
|
case WS_STATES.CONNECTING: {
|
|
this.sdkDriver.connectSession({
|
|
apiKey: this.get("apiKey"),
|
|
sessionId: this.get("sessionId"),
|
|
sessionToken: this.get("sessionToken")
|
|
});
|
|
this.set({callState: CALL_STATES.ONGOING});
|
|
break;
|
|
}
|
|
case WS_STATES.HALF_CONNECTED:
|
|
case WS_STATES.CONNECTED: {
|
|
this.set({callState: CALL_STATES.ONGOING});
|
|
break;
|
|
}
|
|
default: {
|
|
console.error("Unexpected websocket state passed to connectionProgress:",
|
|
actionData.wsState);
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Handles the gather call data action, setting the state
|
|
* and starting to get the appropriate data for the type of call.
|
|
*
|
|
* @param {sharedActions.GatherCallData} actionData The action data.
|
|
*/
|
|
gatherCallData: function(actionData) {
|
|
if (!actionData.outgoing) {
|
|
// XXX Other types aren't supported yet, but set the state for the
|
|
// view selection.
|
|
this.set({outgoing: false});
|
|
return;
|
|
}
|
|
|
|
var callData = navigator.mozLoop.getCallData(actionData.callId);
|
|
if (!callData) {
|
|
console.error("Failed to get the call data");
|
|
this.set({callState: CALL_STATES.TERMINATED});
|
|
return;
|
|
}
|
|
|
|
this.set({
|
|
contact: callData.contact,
|
|
outgoing: actionData.outgoing,
|
|
callId: actionData.callId,
|
|
callType: callData.callType,
|
|
callState: CALL_STATES.GATHER
|
|
});
|
|
|
|
this.set({videoMuted: this.get("callType") === CALL_TYPES.AUDIO_ONLY});
|
|
|
|
if (this.get("outgoing")) {
|
|
this._setupOutgoingCall();
|
|
} // XXX Else, other types aren't supported yet.
|
|
},
|
|
|
|
/**
|
|
* Handles the connect call action, this saves the appropriate
|
|
* data and starts the connection for the websocket to notify the
|
|
* server of progress.
|
|
*
|
|
* @param {sharedActions.ConnectCall} actionData The action data.
|
|
*/
|
|
connectCall: function(actionData) {
|
|
this.set(actionData.sessionData);
|
|
this._connectWebSocket();
|
|
},
|
|
|
|
/**
|
|
* Hangs up an ongoing call.
|
|
*/
|
|
hangupCall: function() {
|
|
if (this._websocket) {
|
|
// Let the server know the user has hung up.
|
|
this._websocket.mediaFail();
|
|
}
|
|
|
|
this._endSession();
|
|
this.set({callState: CALL_STATES.FINISHED});
|
|
},
|
|
|
|
/**
|
|
* The peer hungup the call.
|
|
*/
|
|
peerHungupCall: function() {
|
|
this._endSession();
|
|
this.set({callState: CALL_STATES.FINISHED});
|
|
},
|
|
|
|
/**
|
|
* Cancels a call
|
|
*/
|
|
cancelCall: function() {
|
|
var callState = this.get("callState");
|
|
if (this._websocket &&
|
|
(callState === CALL_STATES.CONNECTING ||
|
|
callState === CALL_STATES.ALERTING)) {
|
|
// Let the server know the user has hung up.
|
|
this._websocket.cancel();
|
|
}
|
|
|
|
this._endSession();
|
|
this.set({callState: CALL_STATES.CLOSE});
|
|
},
|
|
|
|
/**
|
|
* Retries a call
|
|
*/
|
|
retryCall: function() {
|
|
var callState = this.get("callState");
|
|
if (callState !== CALL_STATES.TERMINATED) {
|
|
console.error("Unexpected retry in state", callState);
|
|
return;
|
|
}
|
|
|
|
this.set({callState: CALL_STATES.GATHER});
|
|
if (this.get("outgoing")) {
|
|
this._setupOutgoingCall();
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Notifies that all media is now connected
|
|
*/
|
|
mediaConnected: function() {
|
|
this._websocket.mediaUp();
|
|
},
|
|
|
|
/**
|
|
* Records the mute state for the stream.
|
|
*
|
|
* @param {sharedActions.setMute} actionData The mute state for the stream type.
|
|
*/
|
|
setMute: function(actionData) {
|
|
var muteType = actionData.type + "Muted";
|
|
this.set(muteType, !actionData.enabled);
|
|
},
|
|
|
|
/**
|
|
* Obtains the outgoing call data from the server and handles the
|
|
* result.
|
|
*/
|
|
_setupOutgoingCall: function() {
|
|
var contactAddresses = [];
|
|
|
|
this.get("contact").email.forEach(function(address) {
|
|
contactAddresses.push(address.value);
|
|
});
|
|
|
|
this.client.setupOutgoingCall(contactAddresses,
|
|
this.get("callType"),
|
|
function(err, result) {
|
|
if (err) {
|
|
console.error("Failed to get outgoing call data", err);
|
|
this.dispatcher.dispatch(
|
|
new sharedActions.ConnectionFailure({reason: "setup"}));
|
|
return;
|
|
}
|
|
|
|
// Success, dispatch a new action.
|
|
this.dispatcher.dispatch(
|
|
new sharedActions.ConnectCall({sessionData: result}));
|
|
}.bind(this)
|
|
);
|
|
},
|
|
|
|
/**
|
|
* Sets up and connects the websocket to the server. The websocket
|
|
* deals with sending and obtaining status via the server about the
|
|
* setup of the call.
|
|
*/
|
|
_connectWebSocket: function() {
|
|
this._websocket = new loop.CallConnectionWebSocket({
|
|
url: this.get("progressURL"),
|
|
callId: this.get("callId"),
|
|
websocketToken: this.get("websocketToken")
|
|
});
|
|
|
|
this._websocket.promiseConnect().then(
|
|
function(progressState) {
|
|
this.dispatcher.dispatch(new sharedActions.ConnectionProgress({
|
|
// This is the websocket call state, i.e. waiting for the
|
|
// other end to connect to the server.
|
|
wsState: progressState
|
|
}));
|
|
}.bind(this),
|
|
function(error) {
|
|
console.error("Websocket failed to connect", error);
|
|
this.dispatcher.dispatch(new sharedActions.ConnectionFailure({
|
|
reason: "websocket-setup"
|
|
}));
|
|
}.bind(this)
|
|
);
|
|
|
|
this.listenTo(this._websocket, "progress", this._handleWebSocketProgress);
|
|
},
|
|
|
|
/**
|
|
* Ensures the session is ended and the websocket is disconnected.
|
|
*/
|
|
_endSession: function(nextState) {
|
|
this.sdkDriver.disconnectSession();
|
|
if (this._websocket) {
|
|
this.stopListening(this._websocket);
|
|
|
|
// Now close the websocket.
|
|
this._websocket.close();
|
|
delete this._websocket;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Used to handle any progressed received from the websocket. This will
|
|
* dispatch new actions so that the data can be handled appropriately.
|
|
*/
|
|
_handleWebSocketProgress: function(progressData) {
|
|
var action;
|
|
|
|
switch(progressData.state) {
|
|
case WS_STATES.TERMINATED: {
|
|
action = new sharedActions.ConnectionFailure({
|
|
reason: progressData.reason
|
|
});
|
|
break;
|
|
}
|
|
default: {
|
|
action = new sharedActions.ConnectionProgress({
|
|
wsState: progressData.state
|
|
});
|
|
break;
|
|
}
|
|
}
|
|
|
|
this.dispatcher.dispatch(action);
|
|
}
|
|
});
|
|
|
|
return ConversationStore;
|
|
})();
|