toolkit/components/formautofill/FormAutofill.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 import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
   6 import { Region } from "resource://gre/modules/Region.sys.mjs";
   7 import { AddressMetaDataLoader } from "resource://gre/modules/shared/AddressMetaDataLoader.sys.mjs";
   8
   9 const AUTOFILL_ADDRESSES_AVAILABLE_PREF =
  10   "extensions.formautofill.addresses.supported";
  11 // This pref should be refactored after the migration of the old bool pref
  12 const AUTOFILL_CREDITCARDS_AVAILABLE_PREF =
  13   "extensions.formautofill.creditCards.supported";
  14 const BROWSER_SEARCH_REGION_PREF = "browser.search.region";
  15 const CREDITCARDS_AUTOFILL_SUPPORTED_COUNTRIES_PREF =
  16   "extensions.formautofill.creditCards.supportedCountries";
  17 const ENABLED_AUTOFILL_ADDRESSES_PREF =
  18   "extensions.formautofill.addresses.enabled";
  19 const ENABLED_AUTOFILL_ADDRESSES_CAPTURE_PREF =
  20   "extensions.formautofill.addresses.capture.enabled";
  21 const ENABLED_AUTOFILL_ADDRESSES_CAPTURE_REQUIRED_FIELDS_PREF =
  22   "extensions.formautofill.addresses.capture.requiredFields";
  23 const ENABLED_AUTOFILL_ADDRESSES_SUPPORTED_COUNTRIES_PREF =
  24   "extensions.formautofill.addresses.supportedCountries";
  25 const ENABLED_AUTOFILL_CREDITCARDS_PREF =
  26   "extensions.formautofill.creditCards.enabled";
  27 const AUTOFILL_CREDITCARDS_REAUTH_PREF =
  28   "extensions.formautofill.creditCards.reauth.optout";
  29 const AUTOFILL_CREDITCARDS_HIDE_UI_PREF =
  30   "extensions.formautofill.creditCards.hideui";
  31 const FORM_AUTOFILL_SUPPORT_RTL_PREF = "extensions.formautofill.supportRTL";
  32 const AUTOFILL_CREDITCARDS_AUTOCOMPLETE_OFF_PREF =
  33   "extensions.formautofill.creditCards.ignoreAutocompleteOff";
  34 const AUTOFILL_ADDRESSES_AUTOCOMPLETE_OFF_PREF =
  35   "extensions.formautofill.addresses.ignoreAutocompleteOff";
  36 const ENABLED_AUTOFILL_CAPTURE_ON_FORM_REMOVAL_PREF =
  37   "extensions.formautofill.heuristics.captureOnFormRemoval";
  38 const ENABLED_AUTOFILL_CAPTURE_ON_PAGE_NAVIGATION_PREF =
  39   "extensions.formautofill.heuristics.captureOnPageNavigation";
  40 const ENABLED_AUTOFILL_SAME_ORIGIN_WITH_TOP =
  41   "extensions.formautofill.heuristics.autofillSameOriginWithTop";
  42
  43 export const FormAutofill = {
  44   ENABLED_AUTOFILL_ADDRESSES_PREF,
  45   ENABLED_AUTOFILL_ADDRESSES_CAPTURE_PREF,
  46   ENABLED_AUTOFILL_CAPTURE_ON_FORM_REMOVAL_PREF,
  47   ENABLED_AUTOFILL_CAPTURE_ON_PAGE_NAVIGATION_PREF,
  48   ENABLED_AUTOFILL_SAME_ORIGIN_WITH_TOP,
  49   ENABLED_AUTOFILL_CREDITCARDS_PREF,
  50   AUTOFILL_CREDITCARDS_REAUTH_PREF,
  51   AUTOFILL_CREDITCARDS_AUTOCOMPLETE_OFF_PREF,
  52   AUTOFILL_ADDRESSES_AUTOCOMPLETE_OFF_PREF,
  53
  54   _region: null,
  55
  56   get DEFAULT_REGION() {
  57     return this._region || Region.home || "US";
  58   },
  59
  60   set DEFAULT_REGION(region) {
  61     this._region = region;
  62   },
  63
  64   /**
  65    * Determines if an autofill feature should be enabled based on the "available"
  66    * and "supportedCountries" parameters.
  67    *
  68    * @param {string} available Available can be one of the following: "on", "detect", "off".
  69    * "on" forces the particular Form Autofill feature on, while "detect" utilizes the supported countries
  70    * to see if the feature should be available.
  71    * @param {string[]} supportedCountries
  72    * @returns {boolean} `true` if autofill feature is supported in the current browser search region
  73    */
  74   _isSupportedRegion(available, supportedCountries) {
  75     if (available == "on") {
  76       return true;
  77     } else if (available == "detect") {
  78       if (!FormAutofill.supportRTL && Services.locale.isAppLocaleRTL) {
  79         return false;
  80       }
  81
  82       return supportedCountries.includes(FormAutofill.browserSearchRegion);
  83     }
  84     return false;
  85   },
  86
  87   /**
  88    * Return true if address autofill is available for a specific country.
  89    */
  90   isAutofillAddressesAvailableInCountry(country) {
  91     if (FormAutofill._isAutofillAddressesAvailableInExperiment) {
  92       return true;
  93     }
  94
  95     let available = FormAutofill._isAutofillAddressesAvailable;
  96     if (country && available == "detect") {
  97       return FormAutofill._addressAutofillSupportedCountries.includes(
  98         country.toUpperCase()
  99       );
 100     }
 101     return available == "on";
 102   },
 103   get isAutofillEnabled() {
 104     return this.isAutofillAddressesEnabled || this.isAutofillCreditCardsEnabled;
 105   },
 106   /**
 107    * Determines if the credit card autofill feature is available to use in the browser.
 108    * If the feature is not available, then there are no user facing ways to enable it.
 109    *
 110    * @returns {boolean} `true` if credit card autofill is available
 111    */
 112   get isAutofillCreditCardsAvailable() {
 113     return this._isSupportedRegion(
 114       FormAutofill._isAutofillCreditCardsAvailable,
 115       FormAutofill._creditCardAutofillSupportedCountries
 116     );
 117   },
 118   /**
 119    * Determines if the address autofill feature is available to use in the browser.
 120    * If the feature is not available, then there are no user facing ways to enable it.
 121    * Two conditions must be met for the autofill feature to be considered available:
 122    *   1. Address autofill support is confirmed when:
 123    *      - `extensions.formautofill.addresses.supported` is set to `on`.
 124    *      - The user is located in a region supported by the feature
 125    *        (`extensions.formautofill.creditCards.supportedCountries`).
 126    *   2. Address autofill is enabled through a Nimbus experiment:
 127    *      - The experiment pref `extensions.formautofill.addresses.experiments.enabled` is set to true.
 128    *
 129    * @returns {boolean} `true` if address autofill is available
 130    */
 131   get isAutofillAddressesAvailable() {
 132     const isUserInSupportedRegion = this._isSupportedRegion(
 133       FormAutofill._isAutofillAddressesAvailable,
 134       FormAutofill._addressAutofillSupportedCountries
 135     );
 136     return (
 137       isUserInSupportedRegion ||
 138       FormAutofill._isAutofillAddressesAvailableInExperiment
 139     );
 140   },
 141   /**
 142    * Determines if the user has enabled or disabled credit card autofill.
 143    *
 144    * @returns {boolean} `true` if credit card autofill is enabled
 145    */
 146   get isAutofillCreditCardsEnabled() {
 147     return (
 148       this.isAutofillCreditCardsAvailable &&
 149       FormAutofill._isAutofillCreditCardsEnabled
 150     );
 151   },
 152   /**
 153    * Determines if credit card autofill is locked by policy.
 154    *
 155    * @returns {boolean} `true` if credit card autofill is locked
 156    */
 157   get isAutofillCreditCardsLocked() {
 158     return Services.prefs.prefIsLocked(ENABLED_AUTOFILL_CREDITCARDS_PREF);
 159   },
 160   /**
 161    * Determines if the user has enabled or disabled address autofill.
 162    *
 163    * @returns {boolean} `true` if address autofill is enabled
 164    */
 165   get isAutofillAddressesEnabled() {
 166     return (
 167       this.isAutofillAddressesAvailable &&
 168       FormAutofill._isAutofillAddressesEnabled
 169     );
 170   },
 171   /**
 172    * Determines if address autofill is locked by policy.
 173    *
 174    * @returns {boolean} `true` if address autofill is locked
 175    */
 176   get isAutofillAddressesLocked() {
 177     return Services.prefs.prefIsLocked(ENABLED_AUTOFILL_ADDRESSES_PREF);
 178   },
 179
 180   defineLogGetter(scope, logPrefix) {
 181     // A logging helper for debug logging to avoid creating Console objects
 182     // or triggering expensive JS -> C++ calls when debug logging is not
 183     // enabled.
 184     //
 185     // Console objects, even natively-implemented ones, can consume a lot of
 186     // memory, and since this code may run in every content process, that
 187     // memory can add up quickly. And, even when debug-level messages are
 188     // being ignored, console.debug() calls can be expensive.
 189     //
 190     // This helper avoids both of those problems by never touching the
 191     // console object unless debug logging is enabled.
 192     scope.debug = function debug() {
 193       if (FormAutofill.logLevel.toLowerCase() == "debug") {
 194         this.log.debug(...arguments);
 195       }
 196     };
 197
 198     let { ConsoleAPI } = ChromeUtils.importESModule(
 199       "resource://gre/modules/Console.sys.mjs"
 200     );
 201     return new ConsoleAPI({
 202       maxLogLevelPref: "extensions.formautofill.loglevel",
 203       prefix: logPrefix,
 204     });
 205   },
 206
 207   get isMLExperimentEnabled() {
 208     return FormAutofill._isMLEnabled && FormAutofill._isMLExperimentEnabled;
 209   },
 210 };
 211
 212 // TODO: Bug 1747284. Use Region.home instead of reading "browser.serach.region"
 213 // by default. However, Region.home doesn't observe preference change at this point,
 214 // we should also fix that issue.
 215 XPCOMUtils.defineLazyPreferenceGetter(
 216   FormAutofill,
 217   "browserSearchRegion",
 218   BROWSER_SEARCH_REGION_PREF,
 219   FormAutofill.DEFAULT_REGION
 220 );
 221 XPCOMUtils.defineLazyPreferenceGetter(
 222   FormAutofill,
 223   "logLevel",
 224   "extensions.formautofill.loglevel",
 225   "Warn"
 226 );
 227
 228 XPCOMUtils.defineLazyPreferenceGetter(
 229   FormAutofill,
 230   "_isAutofillAddressesAvailable",
 231   AUTOFILL_ADDRESSES_AVAILABLE_PREF
 232 );
 233 XPCOMUtils.defineLazyPreferenceGetter(
 234   FormAutofill,
 235   "_isAutofillAddressesEnabled",
 236   ENABLED_AUTOFILL_ADDRESSES_PREF
 237 );
 238 XPCOMUtils.defineLazyPreferenceGetter(
 239   FormAutofill,
 240   "isAutofillAddressesCaptureEnabled",
 241   ENABLED_AUTOFILL_ADDRESSES_CAPTURE_PREF
 242 );
 243 XPCOMUtils.defineLazyPreferenceGetter(
 244   FormAutofill,
 245   "_isAutofillCreditCardsAvailable",
 246   AUTOFILL_CREDITCARDS_AVAILABLE_PREF
 247 );
 248 XPCOMUtils.defineLazyPreferenceGetter(
 249   FormAutofill,
 250   "_isAutofillCreditCardsEnabled",
 251   ENABLED_AUTOFILL_CREDITCARDS_PREF
 252 );
 253 XPCOMUtils.defineLazyPreferenceGetter(
 254   FormAutofill,
 255   "isAutofillCreditCardsHideUI",
 256   AUTOFILL_CREDITCARDS_HIDE_UI_PREF
 257 );
 258 XPCOMUtils.defineLazyPreferenceGetter(
 259   FormAutofill,
 260   "_addressAutofillSupportedCountries",
 261   ENABLED_AUTOFILL_ADDRESSES_SUPPORTED_COUNTRIES_PREF,
 262   null,
 263   val => val.split(",")
 264 );
 265 XPCOMUtils.defineLazyPreferenceGetter(
 266   FormAutofill,
 267   "_creditCardAutofillSupportedCountries",
 268   CREDITCARDS_AUTOFILL_SUPPORTED_COUNTRIES_PREF,
 269   null,
 270   null,
 271   val => val.split(",")
 272 );
 273 XPCOMUtils.defineLazyPreferenceGetter(
 274   FormAutofill,
 275   "supportRTL",
 276   FORM_AUTOFILL_SUPPORT_RTL_PREF
 277 );
 278 XPCOMUtils.defineLazyPreferenceGetter(
 279   FormAutofill,
 280   "creditCardsAutocompleteOff",
 281   AUTOFILL_CREDITCARDS_AUTOCOMPLETE_OFF_PREF
 282 );
 283 XPCOMUtils.defineLazyPreferenceGetter(
 284   FormAutofill,
 285   "addressesAutocompleteOff",
 286   AUTOFILL_ADDRESSES_AUTOCOMPLETE_OFF_PREF
 287 );
 288 XPCOMUtils.defineLazyPreferenceGetter(
 289   FormAutofill,
 290   "captureOnFormRemoval",
 291   ENABLED_AUTOFILL_CAPTURE_ON_FORM_REMOVAL_PREF
 292 );
 293 XPCOMUtils.defineLazyPreferenceGetter(
 294   FormAutofill,
 295   "captureOnPageNavigation",
 296   ENABLED_AUTOFILL_CAPTURE_ON_PAGE_NAVIGATION_PREF
 297 );
 298 XPCOMUtils.defineLazyPreferenceGetter(
 299   FormAutofill,
 300   "addressCaptureRequiredFields",
 301   ENABLED_AUTOFILL_ADDRESSES_CAPTURE_REQUIRED_FIELDS_PREF,
 302   null,
 303   null,
 304   val => val?.split(",").filter(v => !!v)
 305 );
 306 XPCOMUtils.defineLazyPreferenceGetter(
 307   FormAutofill,
 308   "autofillSameOriginWithTop",
 309   ENABLED_AUTOFILL_SAME_ORIGIN_WITH_TOP
 310 );
 311
 312 XPCOMUtils.defineLazyPreferenceGetter(
 313   FormAutofill,
 314   "_isAutofillAddressesAvailableInExperiment",
 315   "extensions.formautofill.addresses.experiments.enabled"
 316 );
 317
 318 XPCOMUtils.defineLazyPreferenceGetter(
 319   FormAutofill,
 320   "_isMLEnabled",
 321   "browser.ml.enable",
 322   false
 323 );
 324
 325 XPCOMUtils.defineLazyPreferenceGetter(
 326   FormAutofill,
 327   "_isMLExperimentEnabled",
 328   "extensions.formautofill.ml.experiment.enabled",
 329   false
 330 );
 331
 332 XPCOMUtils.defineLazyPreferenceGetter(
 333   FormAutofill,
 334   "MLModelRevision",
 335   "extensions.formautofill.ml.experiment.modelRevision",
 336   null
 337 );
 338
 339 ChromeUtils.defineLazyGetter(FormAutofill, "countries", () =>
 340   AddressMetaDataLoader.getCountries()
 341 );