gecko/browser/components/loop/MozLoopAPI.jsm

798 lines
26 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/. */
"use strict";
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
Cu.import("resource://services-common/utils.js");
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
Cu.import("resource:///modules/loop/LoopCalls.jsm");
Cu.import("resource:///modules/loop/MozLoopService.jsm");
Cu.import("resource:///modules/loop/LoopRooms.jsm");
Cu.import("resource:///modules/loop/LoopContacts.jsm");
Cu.importGlobalProperties(["Blob"]);
XPCOMUtils.defineLazyModuleGetter(this, "LoopContacts",
"resource:///modules/loop/LoopContacts.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "LoopStorage",
"resource:///modules/loop/LoopStorage.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "hookWindowCloseForPanelClose",
"resource://gre/modules/MozSocialAPI.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "PluralForm",
"resource://gre/modules/PluralForm.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "UITour",
"resource:///modules/UITour.jsm");
XPCOMUtils.defineLazyGetter(this, "appInfo", function() {
return Cc["@mozilla.org/xre/app-info;1"]
.getService(Ci.nsIXULAppInfo)
.QueryInterface(Ci.nsIXULRuntime);
});
XPCOMUtils.defineLazyServiceGetter(this, "clipboardHelper",
"@mozilla.org/widget/clipboardhelper;1",
"nsIClipboardHelper");
XPCOMUtils.defineLazyServiceGetter(this, "extProtocolSvc",
"@mozilla.org/uriloader/external-protocol-service;1",
"nsIExternalProtocolService");
this.EXPORTED_SYMBOLS = ["injectLoopAPI"];
/**
* Trying to clone an Error object into a different container will yield an error.
* We can work around this by copying the properties we care about onto a regular
* object.
*
* @param {Error|nsIException} error Error object to copy
* @param {nsIDOMWindow} targetWindow The content window to clone into
*/
const cloneErrorObject = function(error, targetWindow) {
let obj = new targetWindow.Error();
let props = Object.getOwnPropertyNames(error);
// nsIException properties are not enumerable, so we'll try to copy the most
// common and useful ones.
if (!props.length) {
props.push("message", "filename", "lineNumber", "columnNumber", "stack");
}
for (let prop of props) {
let value = error[prop];
// for nsIException objects, the property may not be defined.
if (typeof value == "undefined") {
continue;
}
if (typeof value != "string" && typeof value != "number") {
value = String(value);
}
Object.defineProperty(Cu.waiveXrays(obj), prop, {
configurable: false,
enumerable: true,
value: value,
writable: false
});
}
return obj;
};
/**
* Makes an object or value available to an unprivileged target window.
*
* Primitives are returned as they are, while objects are cloned into the
* specified target. Error objects are also handled correctly.
*
* @param {any} value Value or object to copy
* @param {nsIDOMWindow} targetWindow The content window to copy to
*/
const cloneValueInto = function(value, targetWindow) {
if (!value || typeof value != "object") {
return value;
}
// HAWK request errors contain an nsIException object inside `value`.
if (("error" in value) && (value.error instanceof Ci.nsIException)) {
value = value.error;
}
// Strip Function properties, since they can not be cloned across boundaries
// like this.
for (let prop of Object.getOwnPropertyNames(value)) {
if (typeof value[prop] == "function") {
delete value[prop];
}
}
// Inspect for an error this way, because the Error object is special.
if (value.constructor.name == "Error" || value instanceof Ci.nsIException) {
return cloneErrorObject(value, targetWindow);
}
let clone;
try {
clone = Cu.cloneInto(value, targetWindow);
} catch (ex) {
MozLoopService.log.debug("Failed to clone value:", value);
throw ex;
}
return clone;
};
/**
* Inject any API containing _only_ function properties into the given window.
*
* @param {Object} api Object containing functions that need to
* be exposed to content
* @param {nsIDOMWindow} targetWindow The content window to attach the API
*/
const injectObjectAPI = function(api, targetWindow) {
let injectedAPI = {};
// Wrap all the methods in `api` to help results passed to callbacks get
// through the priv => unpriv barrier with `Cu.cloneInto()`.
Object.keys(api).forEach(func => {
injectedAPI[func] = function(...params) {
let lastParam = params.pop();
let callbackIsFunction = (typeof lastParam == "function");
// Clone params coming from content to the current scope.
params = [cloneValueInto(p, api) for (p of params)];
// If the last parameter is a function, assume its a callback
// and wrap it differently.
if (callbackIsFunction) {
api[func](...params, function(...results) {
// When the function was garbage collected due to async events, like
// closing a window, we want to circumvent a JS error.
if (callbackIsFunction && typeof lastParam != "function") {
MozLoopService.log.debug(func + ": callback function was lost.");
// Assume the presence of a first result argument to be an error.
if (results[0]) {
MozLoopService.log.error(func + " error:", results[0]);
}
return;
}
lastParam(...[cloneValueInto(r, targetWindow) for (r of results)]);
});
} else {
try {
lastParam = cloneValueInto(lastParam, api);
return cloneValueInto(api[func](...params, lastParam), targetWindow);
} catch (ex) {
return cloneValueInto(ex, targetWindow);
}
}
};
});
let contentObj = Cu.cloneInto(injectedAPI, targetWindow, {cloneFunctions: true});
// Since we deny preventExtensions on XrayWrappers, because Xray semantics make
// it difficult to act like an object has actually been frozen, we try to seal
// the `contentObj` without Xrays.
try {
Object.seal(Cu.waiveXrays(contentObj));
} catch (ex) {}
return contentObj;
};
/**
* Inject the loop API into the given window. The caller must be sure the
* window is a loop content window (eg, a panel, chatwindow, or similar).
*
* See the documentation on the individual functions for details of the API.
*
* @param {nsIDOMWindow} targetWindow The content window to attach the API.
*/
function injectLoopAPI(targetWindow) {
let ringer;
let ringerStopper;
let appVersionInfo;
let contactsAPI;
let roomsAPI;
let callsAPI;
let api = {
/**
* Gets an object with data that represents the currently
* authenticated user's identity.
*
* @return null if user not logged in; profile object otherwise
*/
userProfile: {
enumerable: true,
get: function() {
if (!MozLoopService.userProfile)
return null;
let userProfile = Cu.cloneInto({
email: MozLoopService.userProfile.email,
uid: MozLoopService.userProfile.uid
}, targetWindow);
return userProfile;
}
},
/**
* Sets and gets the "do not disturb" mode activation flag.
*/
doNotDisturb: {
enumerable: true,
get: function() {
return MozLoopService.doNotDisturb;
},
set: function(aFlag) {
MozLoopService.doNotDisturb = aFlag;
}
},
errors: {
enumerable: true,
get: function() {
let errors = {};
for (let [type, error] of MozLoopService.errors) {
// if error.error is an nsIException, just delete it since it's hard
// to clone across the boundary.
if (error.error instanceof Ci.nsIException) {
MozLoopService.log.debug("Warning: Some errors were omitted from MozLoopAPI.errors " +
"due to issues copying nsIException across boundaries.",
error.error);
delete error.error;
}
// We have to clone the error property since it may be an Error object.
if (error.hasOwnProperty("toString")) {
delete error.toString;
}
errors[type] = Cu.waiveXrays(Cu.cloneInto(error, targetWindow, { cloneFunctions: true }));
}
return Cu.cloneInto(errors, targetWindow, { cloneFunctions: true });
},
},
/**
* Returns the current locale of the browser.
*
* @returns {String} The locale string
*/
locale: {
enumerable: true,
get: function() {
return MozLoopService.locale;
}
},
/**
* Returns the window data for a specific conversation window id.
*
* This data will be relevant to the type of window, e.g. rooms or calls.
* See LoopRooms or LoopCalls for more information.
*
* @param {String} conversationWindowId
* @returns {Object} The window data or null if error.
*/
getConversationWindowData: {
enumerable: true,
writable: true,
value: function(conversationWindowId) {
return cloneValueInto(MozLoopService.getConversationWindowData(conversationWindowId),
targetWindow);
}
},
/**
* Returns the contacts API.
*
* @returns {Object} The contacts API object
*/
contacts: {
enumerable: true,
get: function() {
if (contactsAPI) {
return contactsAPI;
}
// Make a database switch when a userProfile is active already.
let profile = MozLoopService.userProfile;
if (profile) {
LoopStorage.switchDatabase(profile.uid);
}
return contactsAPI = injectObjectAPI(LoopContacts, targetWindow);
}
},
/**
* Returns the rooms API.
*
* @returns {Object} The rooms API object
*/
rooms: {
enumerable: true,
get: function() {
if (roomsAPI) {
return roomsAPI;
}
return roomsAPI = injectObjectAPI(LoopRooms, targetWindow);
}
},
/**
* Returns the calls API.
*
* @returns {Object} The rooms API object
*/
calls: {
enumerable: true,
get: function() {
if (callsAPI) {
return callsAPI;
}
return callsAPI = injectObjectAPI(LoopCalls, targetWindow);
}
},
/**
* Import a list of (new) contacts from an external data source.
*
* @param {Object} options Property bag of options for the importer
* @param {Function} callback Function that will be invoked once the operation
* finished. The first argument passed will be an
* `Error` object or `null`. The second argument will
* be the result of the operation, if successfull.
*/
startImport: {
enumerable: true,
writable: true,
value: function(options, callback) {
LoopContacts.startImport(options, getChromeWindow(targetWindow), function(...results) {
callback(...[cloneValueInto(r, targetWindow) for (r of results)]);
});
}
},
/**
* Returns translated strings associated with an element. Designed
* for use with l10n.js
*
* @param {String} key The element id
* @returns {Object} A JSON string containing the localized
* attribute/value pairs for the element.
*/
getStrings: {
enumerable: true,
writable: true,
value: function(key) {
return MozLoopService.getStrings(key);
}
},
/**
* Returns the correct form of a semi-colon separated string
* based on the value of the `num` argument and the current locale.
*
* @param {Integer} num The number used to find the plural form.
* @param {String} str The semi-colon separated string of word forms.
* @returns {String} The correct word form based on the value of the number
* and the current locale.
*/
getPluralForm: {
enumerable: true,
writable: true,
value: function(num, str) {
return PluralForm.get(num, str);
}
},
/**
* Displays a confirmation dialog using the specified strings.
*
* @param {Object} options Confirm dialog options
* @param {Function} callback Function that will be invoked once the operation
* finished. The first argument passed will be an
* `Error` object or `null`. The second argument
* will be the result of the operation, TRUE if
* the user chose the OK button.
*/
confirm: {
enumerable: true,
writable: true,
value: function(options, callback) {
let buttonFlags;
if (options.okButton && options.cancelButton) {
buttonFlags =
(Ci.nsIPrompt.BUTTON_POS_0 * Ci.nsIPrompt.BUTTON_TITLE_IS_STRING) +
(Ci.nsIPrompt.BUTTON_POS_1 * Ci.nsIPrompt.BUTTON_TITLE_IS_STRING);
} else if (!options.okButton && !options.cancelButton) {
buttonFlags = Services.prompt.STD_YES_NO_BUTTONS;
} else {
callback(cloneValueInto(new Error("confirm: missing button options"), targetWindow));
}
try {
let chosenButton = Services.prompt.confirmEx(null, "",
options.message, buttonFlags, options.okButton, options.cancelButton,
null, null, {});
callback(null, chosenButton == 0);
} catch (ex) {
callback(cloneValueInto(ex, targetWindow));
}
}
},
/**
* Set any preference under "loop."
*
* @param {String} prefName The name of the pref without the preceding "loop."
* @param {*} value The value to set.
* @param {Enum} prefType Type of preference, defined at Ci.nsIPrefBranch. Optional.
*
* Any errors thrown by the Mozilla pref API are logged to the console
* and cause false to be returned.
*/
setLoopPref: {
enumerable: true,
writable: true,
value: function(prefName, value, prefType) {
MozLoopService.setLoopPref(prefName, value, prefType);
}
},
/**
* Return any preference under "loop.".
*
* @param {String} prefName The name of the pref without the preceding
* "loop."
* @param {Enum} prefType Type of preference, defined at Ci.nsIPrefBranch. Optional.
*
* Any errors thrown by the Mozilla pref API are logged to the console
* and cause null to be returned. This includes the case of the preference
* not being found.
*
* @return {*} on success, null on error
*/
getLoopPref: {
enumerable: true,
writable: true,
value: function(prefName, prefType) {
return MozLoopService.getLoopPref(prefName);
}
},
/**
* Starts alerting the user about an incoming call
*/
startAlerting: {
enumerable: true,
writable: true,
value: function() {
let chromeWindow = getChromeWindow(targetWindow);
chromeWindow.getAttention();
ringer = new chromeWindow.Audio();
ringer.src = Services.prefs.getCharPref("loop.ringtone");
ringer.loop = true;
ringer.load();
ringer.play();
targetWindow.document.addEventListener("visibilitychange",
ringerStopper = function(event) {
if (event.currentTarget.hidden) {
api.stopAlerting.value();
}
});
}
},
/**
* Stops alerting the user about an incoming call
*/
stopAlerting: {
enumerable: true,
writable: true,
value: function() {
if (ringerStopper) {
targetWindow.document.removeEventListener("visibilitychange",
ringerStopper);
ringerStopper = null;
}
if (ringer) {
ringer.pause();
ringer = null;
}
}
},
/**
* Performs a hawk based request to the loop server.
*
* Callback parameters:
* - {Object|null} null if success. Otherwise an object:
* {
* code: 401,
* errno: 401,
* error: "Request failed",
* message: "invalid token"
* }
* - {String} The body of the response.
*
* @param {LOOP_SESSION_TYPE} sessionType The type of session to use for
* the request. This is one of the
* LOOP_SESSION_TYPE members
* @param {String} path The path to make the request to.
* @param {String} method The request method, e.g. 'POST', 'GET'.
* @param {Object} payloadObj An object which is converted to JSON and
* transmitted with the request.
* @param {Function} callback Called when the request completes.
*/
hawkRequest: {
enumerable: true,
writable: true,
value: function(sessionType, path, method, payloadObj, callback) {
// XXX Should really return a DOM promise here.
let callbackIsFunction = (typeof callback == "function");
MozLoopService.hawkRequest(sessionType, path, method, payloadObj).then((response) => {
callback(null, response.body);
}, hawkError => {
// When the function was garbage collected due to async events, like
// closing a window, we want to circumvent a JS error.
if (callbackIsFunction && typeof callback != "function") {
MozLoopService.log.error("hawkRequest: callback function was lost.", hawkError);
return;
}
// The hawkError.error property, while usually a string representing
// an HTTP response status message, may also incorrectly be a native
// error object that will cause the cloning function to fail.
callback(Cu.cloneInto({
error: (hawkError.error && typeof hawkError.error == "string")
? hawkError.error : "Unexpected exception",
message: hawkError.message,
code: hawkError.code,
errno: hawkError.errno,
}, targetWindow));
}).catch(Cu.reportError);
}
},
LOOP_SESSION_TYPE: {
enumerable: true,
get: function() {
return Cu.cloneInto(LOOP_SESSION_TYPE, targetWindow);
}
},
fxAEnabled: {
enumerable: true,
get: function() {
return MozLoopService.fxAEnabled;
},
},
logInToFxA: {
enumerable: true,
writable: true,
value: function() {
return MozLoopService.logInToFxA();
}
},
logOutFromFxA: {
enumerable: true,
writable: true,
value: function() {
return MozLoopService.logOutFromFxA();
}
},
openFxASettings: {
enumerable: true,
writable: true,
value: function() {
return MozLoopService.openFxASettings();
},
},
/**
* Opens the Getting Started tour in the browser.
*
* @param {String} aSrc
* - The UI element that the user used to begin the tour, optional.
*/
openGettingStartedTour: {
enumerable: true,
writable: true,
value: function(aSrc) {
return MozLoopService.openGettingStartedTour(aSrc);
},
},
/**
* Copies passed string onto the system clipboard.
*
* @param {String} str The string to copy
*/
copyString: {
enumerable: true,
writable: true,
value: function(str) {
clipboardHelper.copyString(str);
}
},
/**
* Returns the app version information for use during feedback.
*
* @return {Object} An object containing:
* - channel: The update channel the application is on
* - version: The application version
* - OS: The operating system the application is running on
*/
appVersionInfo: {
enumerable: true,
get: function() {
if (!appVersionInfo) {
let defaults = Services.prefs.getDefaultBranch(null);
// If the lazy getter explodes, we're probably loaded in xpcshell,
// which doesn't have what we need, so log an error.
try {
appVersionInfo = Cu.cloneInto({
channel: defaults.getCharPref("app.update.channel"),
version: appInfo.version,
OS: appInfo.OS
}, targetWindow);
} catch (ex) {
// only log outside of xpcshell to avoid extra message noise
if (typeof targetWindow !== 'undefined' && "console" in targetWindow) {
MozLoopService.log.error("Failed to construct appVersionInfo; if this isn't " +
"an xpcshell unit test, something is wrong", ex);
}
}
}
return appVersionInfo;
}
},
/**
* Composes an email via the external protocol service.
*
* @param {String} subject Subject of the email to send
* @param {String} body Body message of the email to send
* @param {String} recipient Recipient email address (optional)
*/
composeEmail: {
enumerable: true,
writable: true,
value: function(subject, body, recipient) {
recipient = recipient || "";
let mailtoURL = "mailto:" + encodeURIComponent(recipient) +
"?subject=" + encodeURIComponent(subject) +
"&body=" + encodeURIComponent(body);
extProtocolSvc.loadURI(CommonUtils.makeURI(mailtoURL));
}
},
/**
* Adds a value to a telemetry histogram.
*
* @param {string} histogramId Name of the telemetry histogram to update.
* @param {integer} value Value to add to the histogram.
*/
telemetryAdd: {
enumerable: true,
writable: true,
value: function(histogramId, value) {
Services.telemetry.getHistogramById(histogramId).add(value);
}
},
/**
* Returns a new GUID (UUID) in curly braces format.
*/
generateUUID: {
enumerable: true,
writable: true,
value: function() {
return MozLoopService.generateUUID();
}
},
getAudioBlob: {
enumerable: true,
writable: true,
value: function(name, callback) {
let request = Cc["@mozilla.org/xmlextras/xmlhttprequest;1"]
.createInstance(Ci.nsIXMLHttpRequest);
let url = `chrome://browser/content/loop/shared/sounds/${name}.ogg`;
request.open("GET", url, true);
request.responseType = "arraybuffer";
request.onload = () => {
if (request.status < 200 || request.status >= 300) {
let error = new Error(request.status + " " + request.statusText);
callback(cloneValueInto(error, targetWindow));
return;
}
let blob = new Blob([request.response], {type: "audio/ogg"});
callback(null, cloneValueInto(blob, targetWindow));
};
request.send();
}
},
/**
* Associates a session-id and a call-id with a window for debugging.
*
* @param {string} windowId The window id.
* @param {string} sessionId OT session id.
* @param {string} callId The callId on the server.
*/
addConversationContext: {
enumerable: true,
writable: true,
value: function(windowId, sessionId, callid) {
MozLoopService.addConversationContext(windowId, {
sessionId: sessionId,
callId: callid
});
}
},
/**
* Notifies the UITour module that an event occurred that it might be
* interested in.
*
* @param {String} subject Subject of the notification
*/
notifyUITour: {
enumerable: true,
writable: true,
value: function(subject) {
UITour.notify(subject);
}
},
};
function onStatusChanged(aSubject, aTopic, aData) {
let event = new targetWindow.CustomEvent("LoopStatusChanged");
targetWindow.dispatchEvent(event);
};
function onDOMWindowDestroyed(aSubject, aTopic, aData) {
if (targetWindow && aSubject != targetWindow)
return;
Services.obs.removeObserver(onDOMWindowDestroyed, "dom-window-destroyed");
Services.obs.removeObserver(onStatusChanged, "loop-status-changed");
};
let contentObj = Cu.createObjectIn(targetWindow);
Object.defineProperties(contentObj, api);
Object.seal(contentObj);
Cu.makeObjectPropsNormal(contentObj);
Services.obs.addObserver(onStatusChanged, "loop-status-changed", false);
Services.obs.addObserver(onDOMWindowDestroyed, "dom-window-destroyed", false);
if ("navigator" in targetWindow) {
targetWindow.navigator.wrappedJSObject.__defineGetter__("mozLoop", function () {
// We do this in a getter, so that we create these objects
// only on demand (this is a potential concern, since
// otherwise we might add one per iframe, and keep them
// alive for as long as the window is alive).
delete targetWindow.navigator.wrappedJSObject.mozLoop;
return targetWindow.navigator.wrappedJSObject.mozLoop = contentObj;
});
// Handle window.close correctly on the panel and chatbox.
hookWindowCloseForPanelClose(targetWindow);
} else {
// This isn't a window; but it should be a JS scope; used for testing
return targetWindow.mozLoop = contentObj;
}
}
function getChromeWindow(contentWin) {
return contentWin.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIWebNavigation)
.QueryInterface(Ci.nsIDocShellTreeItem)
.rootTreeItem
.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIDOMWindow);
}