Blame toolkit/modules/AsyncPrefs.jsm

Packit f0b94e
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit f0b94e
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit f0b94e
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit f0b94e
Packit f0b94e
"use strict";
Packit f0b94e
Packit f0b94e
var EXPORTED_SYMBOLS = ["AsyncPrefs"];
Packit f0b94e
Packit f0b94e
ChromeUtils.import("resource://gre/modules/Services.jsm");
Packit f0b94e
Packit f0b94e
const kInChildProcess = Services.appinfo.processType == Services.appinfo.PROCESS_TYPE_CONTENT;
Packit f0b94e
Packit f0b94e
const kAllowedPrefs = new Set([
Packit f0b94e
  // NB: please leave the testing prefs at the top, and sort the rest alphabetically if you add
Packit f0b94e
  // anything.
Packit f0b94e
  "testing.allowed-prefs.some-bool-pref",
Packit f0b94e
  "testing.allowed-prefs.some-char-pref",
Packit f0b94e
  "testing.allowed-prefs.some-int-pref",
Packit f0b94e
Packit f0b94e
  "narrate.rate",
Packit f0b94e
  "narrate.voice",
Packit f0b94e
Packit f0b94e
  "privacy.trackingprotection.pbmode.enabled",
Packit f0b94e
Packit f0b94e
  "reader.font_size",
Packit f0b94e
  "reader.font_type",
Packit f0b94e
  "reader.color_scheme",
Packit f0b94e
  "reader.content_width",
Packit f0b94e
  "reader.line_height",
Packit f0b94e
]);
Packit f0b94e
Packit f0b94e
const kPrefTypeMap = new Map([
Packit f0b94e
  ["boolean", Services.prefs.PREF_BOOL],
Packit f0b94e
  ["number", Services.prefs.PREF_INT],
Packit f0b94e
  ["string", Services.prefs.PREF_STRING],
Packit f0b94e
]);
Packit f0b94e
Packit f0b94e
function maybeReturnErrorForReset(pref) {
Packit f0b94e
  if (!kAllowedPrefs.has(pref)) {
Packit f0b94e
    return `Resetting pref ${pref} from content is not allowed.`;
Packit f0b94e
  }
Packit f0b94e
  return false;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
function maybeReturnErrorForSet(pref, value) {
Packit f0b94e
  if (!kAllowedPrefs.has(pref)) {
Packit f0b94e
    return `Setting pref ${pref} from content is not allowed.`;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  let valueType = typeof value;
Packit f0b94e
  if (!kPrefTypeMap.has(valueType)) {
Packit f0b94e
    return `Can't set pref ${pref} to value of type ${valueType}.`;
Packit f0b94e
  }
Packit f0b94e
  let prefType = Services.prefs.getPrefType(pref);
Packit f0b94e
  if (prefType != Services.prefs.PREF_INVALID &&
Packit f0b94e
      prefType != kPrefTypeMap.get(valueType)) {
Packit f0b94e
    return `Can't set pref ${pref} to a value with type ${valueType} that doesn't match the pref's type ${prefType}.`;
Packit f0b94e
  }
Packit f0b94e
  return false;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
var AsyncPrefs;
Packit f0b94e
if (kInChildProcess) {
Packit f0b94e
  let gUniqueId = 0;
Packit f0b94e
  let gMsgMap = new Map();
Packit f0b94e
Packit f0b94e
  AsyncPrefs = {
Packit f0b94e
    set(pref, value) {
Packit f0b94e
      let error = maybeReturnErrorForSet(pref, value);
Packit f0b94e
      if (error) {
Packit f0b94e
        return Promise.reject(error);
Packit f0b94e
      }
Packit f0b94e
Packit f0b94e
      let msgId = ++gUniqueId;
Packit f0b94e
      return new Promise((resolve, reject) => {
Packit f0b94e
        gMsgMap.set(msgId, {resolve, reject});
Packit f0b94e
        Services.cpmm.sendAsyncMessage("AsyncPrefs:SetPref", {pref, value, msgId});
Packit f0b94e
      });
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    reset(pref) {
Packit f0b94e
      let error = maybeReturnErrorForReset(pref);
Packit f0b94e
      if (error) {
Packit f0b94e
        return Promise.reject(error);
Packit f0b94e
      }
Packit f0b94e
Packit f0b94e
      let msgId = ++gUniqueId;
Packit f0b94e
      return new Promise((resolve, reject) => {
Packit f0b94e
        gMsgMap.set(msgId, {resolve, reject});
Packit f0b94e
        Services.cpmm.sendAsyncMessage("AsyncPrefs:ResetPref", {pref, msgId});
Packit f0b94e
      });
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    receiveMessage(msg) {
Packit f0b94e
      let promiseRef = gMsgMap.get(msg.data.msgId);
Packit f0b94e
      if (promiseRef) {
Packit f0b94e
        gMsgMap.delete(msg.data.msgId);
Packit f0b94e
        if (msg.data.success) {
Packit f0b94e
          promiseRef.resolve();
Packit f0b94e
        } else {
Packit f0b94e
          promiseRef.reject(msg.data.message);
Packit f0b94e
        }
Packit f0b94e
      }
Packit f0b94e
    },
Packit f0b94e
  };
Packit f0b94e
Packit f0b94e
  Services.cpmm.addMessageListener("AsyncPrefs:PrefSetFinished", AsyncPrefs);
Packit f0b94e
  Services.cpmm.addMessageListener("AsyncPrefs:PrefResetFinished", AsyncPrefs);
Packit f0b94e
} else {
Packit f0b94e
  AsyncPrefs = {
Packit f0b94e
    methodForType: {
Packit f0b94e
      number: "setIntPref",
Packit f0b94e
      boolean: "setBoolPref",
Packit f0b94e
      string: "setCharPref",
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    set(pref, value) {
Packit f0b94e
      let error = maybeReturnErrorForSet(pref, value);
Packit f0b94e
      if (error) {
Packit f0b94e
        return Promise.reject(error);
Packit f0b94e
      }
Packit f0b94e
      let methodToUse = this.methodForType[typeof value];
Packit f0b94e
      try {
Packit f0b94e
        Services.prefs[methodToUse](pref, value);
Packit f0b94e
        return Promise.resolve(value);
Packit f0b94e
      } catch (ex) {
Packit f0b94e
        Cu.reportError(ex);
Packit f0b94e
        return Promise.reject(ex.message);
Packit f0b94e
      }
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    reset(pref) {
Packit f0b94e
      let error = maybeReturnErrorForReset(pref);
Packit f0b94e
      if (error) {
Packit f0b94e
        return Promise.reject(error);
Packit f0b94e
      }
Packit f0b94e
Packit f0b94e
      try {
Packit f0b94e
        Services.prefs.clearUserPref(pref);
Packit f0b94e
        return Promise.resolve();
Packit f0b94e
      } catch (ex) {
Packit f0b94e
        Cu.reportError(ex);
Packit f0b94e
        return Promise.reject(ex.message);
Packit f0b94e
      }
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    receiveMessage(msg) {
Packit f0b94e
      if (msg.name == "AsyncPrefs:SetPref") {
Packit f0b94e
        this.onPrefSet(msg);
Packit f0b94e
      } else {
Packit f0b94e
        this.onPrefReset(msg);
Packit f0b94e
      }
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    onPrefReset(msg) {
Packit f0b94e
      let {pref, msgId} = msg.data;
Packit f0b94e
      this.reset(pref).then(function() {
Packit f0b94e
        msg.target.sendAsyncMessage("AsyncPrefs:PrefResetFinished", {msgId, success: true});
Packit f0b94e
      }, function(msg) {
Packit f0b94e
        msg.target.sendAsyncMessage("AsyncPrefs:PrefResetFinished", {msgId, success: false, message: msg});
Packit f0b94e
      });
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    onPrefSet(msg) {
Packit f0b94e
      let {pref, value, msgId} = msg.data;
Packit f0b94e
      this.set(pref, value).then(function() {
Packit f0b94e
        msg.target.sendAsyncMessage("AsyncPrefs:PrefSetFinished", {msgId, success: true});
Packit f0b94e
      }, function(msg) {
Packit f0b94e
        msg.target.sendAsyncMessage("AsyncPrefs:PrefSetFinished", {msgId, success: false, message: msg});
Packit f0b94e
      });
Packit f0b94e
    },
Packit f0b94e
Packit f0b94e
    init() {
Packit f0b94e
      // PLEASE KEEP THIS LIST IN SYNC WITH THE LISTENERS ADDED IN nsBrowserGlue
Packit f0b94e
      Services.ppmm.addMessageListener("AsyncPrefs:SetPref", this);
Packit f0b94e
      Services.ppmm.addMessageListener("AsyncPrefs:ResetPref", this);
Packit f0b94e
      // PLEASE KEEP THIS LIST IN SYNC WITH THE LISTENERS ADDED IN nsBrowserGlue
Packit f0b94e
    }
Packit f0b94e
  };
Packit f0b94e
}