toolkit/modules/AsyncPrefs.sys.mjs

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 const kInChildProcess =
   6   Services.appinfo.processType == Services.appinfo.PROCESS_TYPE_CONTENT;
   7
   8 const kAllowedPrefs = new Set([
   9   // NB: please leave the testing prefs at the top, and sort the rest alphabetically if you add
  10   // anything.
  11   "testing.allowed-prefs.some-bool-pref",
  12   "testing.allowed-prefs.some-char-pref",
  13   "testing.allowed-prefs.some-int-pref",
  14
  15   "browser.contentblocking.report.hide_vpn_banner",
  16   "browser.contentblocking.report.show_mobile_app",
  17
  18   "browser.shopping.experience2023.optedIn",
  19   "browser.shopping.experience2023.active",
  20   "browser.shopping.experience2023.ads.userEnabled",
  21
  22   "narrate.rate",
  23   "narrate.voice",
  24
  25   "reader.font_size",
  26   "reader.font_type",
  27   "reader.color_scheme",
  28   "reader.content_width",
  29   "reader.line_height",
  30
  31   "security.tls.version.enable-deprecated",
  32   "security.xfocsp.errorReporting.automatic",
  33
  34   "network.trr.display_fallback_warning",
  35 ]);
  36
  37 const kPrefTypeMap = new Map([
  38   ["boolean", Services.prefs.PREF_BOOL],
  39   ["number", Services.prefs.PREF_INT],
  40   ["string", Services.prefs.PREF_STRING],
  41 ]);
  42
  43 function maybeReturnErrorForReset(pref) {
  44   if (!kAllowedPrefs.has(pref)) {
  45     return `Resetting pref ${pref} from content is not allowed.`;
  46   }
  47   return false;
  48 }
  49
  50 function maybeReturnErrorForSet(pref, value) {
  51   if (!kAllowedPrefs.has(pref)) {
  52     return `Setting pref ${pref} from content is not allowed.`;
  53   }
  54
  55   let valueType = typeof value;
  56   if (!kPrefTypeMap.has(valueType)) {
  57     return `Can't set pref ${pref} to value of type ${valueType}.`;
  58   }
  59   let prefType = Services.prefs.getPrefType(pref);
  60   if (
  61     prefType != Services.prefs.PREF_INVALID &&
  62     prefType != kPrefTypeMap.get(valueType)
  63   ) {
  64     return `Can't set pref ${pref} to a value with type ${valueType} that doesn't match the pref's type ${prefType}.`;
  65   }
  66   return false;
  67 }
  68
  69 export class AsyncPrefsChild extends JSProcessActorChild {
  70   set(pref, value) {
  71     let error = maybeReturnErrorForSet(pref, value);
  72     if (error) {
  73       return Promise.reject(error);
  74     }
  75
  76     return this.sendQuery("AsyncPrefs:SetPref", {
  77       pref,
  78       value,
  79     });
  80   }
  81
  82   reset(pref) {
  83     let error = maybeReturnErrorForReset(pref);
  84     if (error) {
  85       return Promise.reject(error);
  86     }
  87
  88     return this.sendQuery("AsyncPrefs:ResetPref", { pref });
  89   }
  90 }
  91
  92 export var AsyncPrefs = {
  93   set(pref, value) {
  94     if (kInChildProcess) {
  95       return ChromeUtils.domProcessChild
  96         .getActor("AsyncPrefs")
  97         .set(pref, value);
  98     }
  99     return AsyncPrefsParent.set(pref, value);
 100   },
 101
 102   reset(pref, value) {
 103     if (kInChildProcess) {
 104       return ChromeUtils.domProcessChild.getActor("AsyncPrefs").reset(pref);
 105     }
 106     return AsyncPrefsParent.reset(pref);
 107   },
 108 };
 109
 110 const methodForType = {
 111   number: "setIntPref",
 112   boolean: "setBoolPref",
 113   string: "setCharPref",
 114 };
 115
 116 export class AsyncPrefsParent extends JSProcessActorParent {
 117   static set(pref, value) {
 118     let error = maybeReturnErrorForSet(pref, value);
 119     if (error) {
 120       return Promise.reject(error);
 121     }
 122     let methodToUse = methodForType[typeof value];
 123     try {
 124       Services.prefs[methodToUse](pref, value);
 125     } catch (ex) {
 126       console.error(ex);
 127       return Promise.reject(ex.message);
 128     }
 129
 130     return Promise.resolve(value);
 131   }
 132
 133   static reset(pref) {
 134     let error = maybeReturnErrorForReset(pref);
 135     if (error) {
 136       return Promise.reject(error);
 137     }
 138
 139     try {
 140       Services.prefs.clearUserPref(pref);
 141     } catch (ex) {
 142       console.error(ex);
 143       return Promise.reject(ex.message);
 144     }
 145
 146     return Promise.resolve();
 147   }
 148
 149   receiveMessage(msg) {
 150     if (msg.name == "AsyncPrefs:SetPref") {
 151       return AsyncPrefsParent.set(msg.data.pref, msg.data.value);
 152     }
 153     return AsyncPrefsParent.reset(msg.data.pref);
 154   }
 155 }