gecko/webapprt/WebappRT.jsm

/* 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/. */

const EXPORTED_SYMBOLS = ["WebappRT"];

const Cc = Components.classes;
const Ci = Components.interfaces;
const Cu = Components.utils;

Cu.import("resource://gre/modules/XPCOMUtils.jsm");
Cu.import("resource://gre/modules/Services.jsm");

XPCOMUtils.defineLazyGetter(this, "FileUtils", function() {
  Cu.import("resource://gre/modules/FileUtils.jsm");
  return FileUtils;
});

XPCOMUtils.defineLazyGetter(this, "DOMApplicationRegistry", function() {
  Cu.import("resource://gre/modules/Webapps.jsm");
  return DOMApplicationRegistry;
});

// In test mode, observe webapps-ask-install so tests can install apps.
Services.obs.addObserver(function observeCmdLine(subj, topic, data) {
  Services.obs.removeObserver(observeCmdLine, "webapprt-command-line");
  let args = subj.QueryInterface(Ci.nsIPropertyBag2);
  if (!args.hasKey("test-mode"))
    return;
  Services.obs.addObserver(function observeInstall(subj, topic, data) {
    // observeInstall is present for the lifetime of the runtime.
    let config = JSON.parse(data);
    config.registryDir = Services.dirsvc.get("ProfD", Ci.nsIFile).path;
    DOMApplicationRegistry.confirmInstall(config);
    delete WebappRT.config;
    WebappRT.config = deepFreeze(config);
    Services.obs.notifyObservers(null, "webapprt-test-did-install",
                                 JSON.stringify(config));
  }, "webapps-ask-install", false);
}, "webapprt-command-line", false);

let WebappRT = {
  get config() {
    let webappFile = FileUtils.getFile("AppRegD", ["webapp.json"]);
    let inputStream = Cc["@mozilla.org/network/file-input-stream;1"].
                      createInstance(Ci.nsIFileInputStream);
    inputStream.init(webappFile, -1, 0, 0);
    let json = Cc["@mozilla.org/dom/json;1"].createInstance(Ci.nsIJSON);
    let config = json.decodeFromStream(inputStream, webappFile.fileSize);

    // Memoize the getter, freezing the `config` object in the meantime so
    // consumers don't inadvertently (or intentionally) change it, as the object
    // is meant to be a read-only representation of the webapp's configuration.
    config = deepFreeze(config);
    delete this.config;
    Object.defineProperty(this, "config", { get: function getConfig() config });
    return this.config;
  }
};

function deepFreeze(o) {
  // First, freeze the object.
  Object.freeze(o);

  // Then recursively call deepFreeze() to freeze its properties.
  for (let p in o) {
    // If the object is on the prototype, not an object, or is already frozen,
    // skip it.  Note that this might leave an unfrozen reference somewhere in
    // the object if there is an already frozen object containing an unfrozen
    // object.
    if (!o.hasOwnProperty(p) || !(typeof o[p] == "object") ||
        Object.isFrozen(o[p]))
      continue;

    deepFreeze(o[p]);
  }

  return o;
}