browser/components/preferences/dialogs/connection.js

   1 /* -*- indent-tabs-mode: nil; js-indent-level: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /* import-globals-from /browser/base/content/utilityOverlay.js */
   7 /* import-globals-from /toolkit/content/preferencesBindings.js */
   8 /* import-globals-from ../extensionControlled.js */
   9
  10 const proxyService = Ci.nsIProtocolProxyService;
  11
  12 const PROXY_TYPES_MAP_REVERSE = new Map([
  13   [proxyService.PROXYCONFIG_DIRECT, "DIRECT"],
  14   [proxyService.PROXYCONFIG_MANUAL, "MANUAL"],
  15   [proxyService.PROXYCONFIG_PAC, "PAC"],
  16   [proxyService.PROXYCONFIG_WPAD, "WPAD"],
  17   [proxyService.PROXYCONFIG_SYSTEM, "SYSTEM"],
  18 ]);
  19
  20 document
  21   .getElementById("ConnectionsDialog")
  22   .addEventListener("dialoghelp", window.top.openPrefsHelp);
  23
  24 Preferences.addAll([
  25   // Add network.proxy.autoconfig_url before network.proxy.type so they're
  26   // both initialized when network.proxy.type initialization triggers a call to
  27   // gConnectionsDialog.updateReloadButton().
  28   { id: "network.proxy.autoconfig_url", type: "string" },
  29   { id: "network.proxy.system_wpad", type: "bool" },
  30   { id: "network.proxy.type", type: "int" },
  31   { id: "network.proxy.http", type: "string" },
  32   { id: "network.proxy.http_port", type: "int" },
  33   { id: "network.proxy.ssl", type: "string" },
  34   { id: "network.proxy.ssl_port", type: "int" },
  35   { id: "network.proxy.socks", type: "string" },
  36   { id: "network.proxy.socks_port", type: "int" },
  37   { id: "network.proxy.socks_version", type: "int" },
  38   { id: "network.proxy.socks_remote_dns", type: "bool" },
  39   { id: "network.proxy.socks5_remote_dns", type: "bool" },
  40   { id: "network.proxy.no_proxies_on", type: "string" },
  41   { id: "network.proxy.share_proxy_settings", type: "bool" },
  42   { id: "signon.autologin.proxy", type: "bool" },
  43   { id: "pref.advanced.proxies.disable_button.reload", type: "bool" },
  44   { id: "network.proxy.backup.ssl", type: "string" },
  45   { id: "network.proxy.backup.ssl_port", type: "int" },
  46 ]);
  47
  48 window.addEventListener(
  49   "DOMContentLoaded",
  50   () => {
  51     Preferences.get("network.proxy.type").on(
  52       "change",
  53       gConnectionsDialog.proxyTypeChanged.bind(gConnectionsDialog)
  54     );
  55     Preferences.get("network.proxy.socks_version").on(
  56       "change",
  57       gConnectionsDialog.updateDNSPref.bind(gConnectionsDialog)
  58     );
  59
  60     document
  61       .getElementById("key_close")
  62       .addEventListener("command", event => Preferences.close(event));
  63
  64     document
  65       .getElementById("disableProxyExtension")
  66       .addEventListener(
  67         "command",
  68         makeDisableControllingExtension(PREF_SETTING_TYPE, PROXY_KEY).bind(
  69           gConnectionsDialog
  70         )
  71       );
  72     document
  73       .getElementById("networkProxyAutoconfigURL")
  74       .addEventListener("input", () => gConnectionsDialog.updateReloadButton());
  75     document
  76       .getElementById("autoReload")
  77       .addEventListener("command", () => gConnectionsDialog.reloadPAC());
  78
  79     gConnectionsDialog.checkForSystemProxy();
  80     gConnectionsDialog.updateProxySettingsUI();
  81     initializeProxyUI(gConnectionsDialog);
  82     gConnectionsDialog.registerSyncPrefListeners();
  83     document
  84       .getElementById("ConnectionsDialog")
  85       .addEventListener("beforeaccept", e =>
  86         gConnectionsDialog.beforeAccept(e)
  87       );
  88   },
  89   { once: true, capture: true }
  90 );
  91
  92 var gConnectionsDialog = {
  93   beforeAccept(event) {
  94     var proxyTypePref = Preferences.get("network.proxy.type");
  95
  96     // collect "network.proxy.type" to glean metrics
  97     let proxyTypePrefStr =
  98       PROXY_TYPES_MAP_REVERSE.get(proxyTypePref.value) || "OTHER";
  99     Glean.networkProxySettings.proxyTypePreference.record({
 100       value: proxyTypePrefStr,
 101     });
 102
 103     if (proxyTypePref.value == 2) {
 104       this.doAutoconfigURLFixup();
 105       return;
 106     }
 107
 108     if (proxyTypePref.value != 1) {
 109       return;
 110     }
 111
 112     var httpProxyURLPref = Preferences.get("network.proxy.http");
 113     var httpProxyPortPref = Preferences.get("network.proxy.http_port");
 114     var shareProxiesPref = Preferences.get(
 115       "network.proxy.share_proxy_settings"
 116     );
 117
 118     // If the proxy server (when specified) is invalid or the port is set to 0 then cancel submission.
 119     for (let prefName of ["http", "ssl", "socks"]) {
 120       let proxyPortPref = Preferences.get(
 121         "network.proxy." + prefName + "_port"
 122       );
 123       let proxyPref = Preferences.get("network.proxy." + prefName);
 124       // Only worry about ports which are currently active. If the share option is on, then ignore
 125       // all ports except the HTTP and SOCKS port
 126       if (
 127         proxyPref.value != "" &&
 128         (prefName == "http" || prefName == "socks" || !shareProxiesPref.value)
 129       ) {
 130         if (proxyPortPref.value == 0) {
 131           document
 132             .getElementById("networkProxy" + prefName.toUpperCase() + "_Port")
 133             .focus();
 134           event.preventDefault();
 135           return;
 136         } else if (!Services.io.isValidHostname(proxyPref.value)) {
 137           document
 138             .getElementById("networkProxy" + prefName.toUpperCase())
 139             .focus();
 140           event.preventDefault();
 141           return;
 142         }
 143       }
 144     }
 145
 146     // In the case of a shared proxy preference, backup the current values and update with the HTTP value
 147     if (shareProxiesPref.value) {
 148       var proxyServerURLPref = Preferences.get("network.proxy.ssl");
 149       var proxyPortPref = Preferences.get("network.proxy.ssl_port");
 150       var backupServerURLPref = Preferences.get("network.proxy.backup.ssl");
 151       var backupPortPref = Preferences.get("network.proxy.backup.ssl_port");
 152       backupServerURLPref.value =
 153         backupServerURLPref.value || proxyServerURLPref.value;
 154       backupPortPref.value = backupPortPref.value || proxyPortPref.value;
 155       proxyServerURLPref.value = httpProxyURLPref.value;
 156       proxyPortPref.value = httpProxyPortPref.value;
 157     }
 158
 159     this.sanitizeNoProxiesPref();
 160   },
 161
 162   checkForSystemProxy() {
 163     if ("@mozilla.org/system-proxy-settings;1" in Cc) {
 164       document.getElementById("systemPref").removeAttribute("hidden");
 165
 166       var systemWpadAllowed = Services.prefs.getBoolPref(
 167         "network.proxy.system_wpad.allowed",
 168         false
 169       );
 170       if (systemWpadAllowed && AppConstants.platform == "win") {
 171         document.getElementById("systemWpad").removeAttribute("hidden");
 172       }
 173     }
 174   },
 175
 176   proxyTypeChanged() {
 177     var proxyTypePref = Preferences.get("network.proxy.type");
 178     var systemWpadPref = Preferences.get("network.proxy.system_wpad");
 179     systemWpadPref.updateControlDisabledState(proxyTypePref.value != 5);
 180
 181     // Update http
 182     var httpProxyURLPref = Preferences.get("network.proxy.http");
 183     httpProxyURLPref.updateControlDisabledState(proxyTypePref.value != 1);
 184     var httpProxyPortPref = Preferences.get("network.proxy.http_port");
 185     httpProxyPortPref.updateControlDisabledState(proxyTypePref.value != 1);
 186
 187     // Now update the other protocols
 188     this.updateProtocolPrefs();
 189
 190     var shareProxiesPref = Preferences.get(
 191       "network.proxy.share_proxy_settings"
 192     );
 193     shareProxiesPref.updateControlDisabledState(proxyTypePref.value != 1);
 194     var autologinProxyPref = Preferences.get("signon.autologin.proxy");
 195     autologinProxyPref.updateControlDisabledState(proxyTypePref.value == 0);
 196     var noProxiesPref = Preferences.get("network.proxy.no_proxies_on");
 197     noProxiesPref.updateControlDisabledState(proxyTypePref.value == 0);
 198
 199     var autoconfigURLPref = Preferences.get("network.proxy.autoconfig_url");
 200     autoconfigURLPref.updateControlDisabledState(proxyTypePref.value != 2);
 201
 202     this.updateReloadButton();
 203
 204     document.getElementById("networkProxyNoneLocalhost").hidden =
 205       Services.prefs.getBoolPref(
 206         "network.proxy.allow_hijacking_localhost",
 207         false
 208       );
 209   },
 210
 211   updateDNSPref() {
 212     var socksVersionPref = Preferences.get("network.proxy.socks_version");
 213     var socks4DNSPref = Preferences.get("network.proxy.socks_remote_dns");
 214     var socks5DNSPref = Preferences.get("network.proxy.socks5_remote_dns");
 215     var proxyTypePref = Preferences.get("network.proxy.type");
 216     var isDefinitelySocks4 =
 217       proxyTypePref.value == 1 && socksVersionPref.value == 4;
 218     socks5DNSPref.updateControlDisabledState(
 219       isDefinitelySocks4 || proxyTypePref.value == 0
 220     );
 221     var isDefinitelySocks5 =
 222       proxyTypePref.value == 1 && socksVersionPref.value == 5;
 223     socks4DNSPref.updateControlDisabledState(
 224       isDefinitelySocks5 || proxyTypePref.value == 0
 225     );
 226     return undefined;
 227   },
 228
 229   updateReloadButton() {
 230     // Disable the "Reload PAC" button if the selected proxy type is not PAC or
 231     // if the current value of the PAC input does not match the value stored
 232     // in prefs.  Likewise, disable the reload button if PAC is not configured
 233     // in prefs.
 234
 235     var typedURL = document.getElementById("networkProxyAutoconfigURL").value;
 236     var proxyTypeCur = Preferences.get("network.proxy.type").value;
 237
 238     var pacURL = Services.prefs.getCharPref("network.proxy.autoconfig_url");
 239     var proxyType = Services.prefs.getIntPref("network.proxy.type");
 240
 241     var disableReloadPref = Preferences.get(
 242       "pref.advanced.proxies.disable_button.reload"
 243     );
 244     disableReloadPref.updateControlDisabledState(
 245       proxyTypeCur != 2 || proxyType != 2 || typedURL != pacURL
 246     );
 247   },
 248
 249   readProxyType() {
 250     this.proxyTypeChanged();
 251     return undefined;
 252   },
 253
 254   updateProtocolPrefs() {
 255     var proxyTypePref = Preferences.get("network.proxy.type");
 256     var shareProxiesPref = Preferences.get(
 257       "network.proxy.share_proxy_settings"
 258     );
 259     var proxyPrefs = ["ssl", "socks"];
 260     for (var i = 0; i < proxyPrefs.length; ++i) {
 261       var proxyServerURLPref = Preferences.get(
 262         "network.proxy." + proxyPrefs[i]
 263       );
 264       var proxyPortPref = Preferences.get(
 265         "network.proxy." + proxyPrefs[i] + "_port"
 266       );
 267
 268       // Restore previous per-proxy custom settings, if present.
 269       if (proxyPrefs[i] != "socks" && !shareProxiesPref.value) {
 270         var backupServerURLPref = Preferences.get(
 271           "network.proxy.backup." + proxyPrefs[i]
 272         );
 273         var backupPortPref = Preferences.get(
 274           "network.proxy.backup." + proxyPrefs[i] + "_port"
 275         );
 276         if (backupServerURLPref.hasUserValue) {
 277           proxyServerURLPref.value = backupServerURLPref.value;
 278           backupServerURLPref.reset();
 279         }
 280         if (backupPortPref.hasUserValue) {
 281           proxyPortPref.value = backupPortPref.value;
 282           backupPortPref.reset();
 283         }
 284       }
 285
 286       proxyServerURLPref.updateElements();
 287       proxyPortPref.updateElements();
 288       let prefIsShared = proxyPrefs[i] != "socks" && shareProxiesPref.value;
 289       proxyServerURLPref.updateControlDisabledState(
 290         proxyTypePref.value != 1 || prefIsShared
 291       );
 292       proxyPortPref.updateControlDisabledState(
 293         proxyTypePref.value != 1 || prefIsShared
 294       );
 295     }
 296     var socksVersionPref = Preferences.get("network.proxy.socks_version");
 297     socksVersionPref.updateControlDisabledState(proxyTypePref.value != 1);
 298     this.updateDNSPref();
 299     return undefined;
 300   },
 301
 302   readProxyProtocolPref(aProtocol, aIsPort) {
 303     if (aProtocol != "socks") {
 304       var shareProxiesPref = Preferences.get(
 305         "network.proxy.share_proxy_settings"
 306       );
 307       if (shareProxiesPref.value) {
 308         var pref = Preferences.get(
 309           "network.proxy.http" + (aIsPort ? "_port" : "")
 310         );
 311         return pref.value;
 312       }
 313
 314       var backupPref = Preferences.get(
 315         "network.proxy.backup." + aProtocol + (aIsPort ? "_port" : "")
 316       );
 317       return backupPref.hasUserValue ? backupPref.value : undefined;
 318     }
 319     return undefined;
 320   },
 321
 322   reloadPAC() {
 323     Cc["@mozilla.org/network/protocol-proxy-service;1"]
 324       .getService()
 325       .reloadPAC();
 326   },
 327
 328   doAutoconfigURLFixup() {
 329     var autoURL = document.getElementById("networkProxyAutoconfigURL");
 330     var autoURLPref = Preferences.get("network.proxy.autoconfig_url");
 331     try {
 332       autoURLPref.value = autoURL.value = Services.uriFixup.getFixupURIInfo(
 333         autoURL.value
 334       ).preferredURI.spec;
 335     } catch (ex) {}
 336   },
 337
 338   sanitizeNoProxiesPref() {
 339     var noProxiesPref = Preferences.get("network.proxy.no_proxies_on");
 340     // replace substrings of ; and \n with commas if they're neither immediately
 341     // preceded nor followed by a valid separator character
 342     noProxiesPref.value = noProxiesPref.value.replace(
 343       /([^, \n;])[;\n]+(?![,\n;])/g,
 344       "$1,"
 345     );
 346     // replace any remaining ; and \n since some may follow commas, etc.
 347     noProxiesPref.value = noProxiesPref.value.replace(/[;\n]/g, "");
 348   },
 349
 350   readHTTPProxyServer() {
 351     var shareProxiesPref = Preferences.get(
 352       "network.proxy.share_proxy_settings"
 353     );
 354     if (shareProxiesPref.value) {
 355       this.updateProtocolPrefs();
 356     }
 357     return undefined;
 358   },
 359
 360   readHTTPProxyPort() {
 361     var shareProxiesPref = Preferences.get(
 362       "network.proxy.share_proxy_settings"
 363     );
 364     if (shareProxiesPref.value) {
 365       this.updateProtocolPrefs();
 366     }
 367     return undefined;
 368   },
 369
 370   getProxyControls() {
 371     let controlGroup = document.getElementById("networkProxyType");
 372     return [
 373       ...controlGroup.querySelectorAll(":scope > radio"),
 374       ...controlGroup.querySelectorAll("label"),
 375       ...controlGroup.querySelectorAll("input"),
 376       ...controlGroup.querySelectorAll("checkbox"),
 377       ...document.querySelectorAll("#networkProxySOCKSVersion > radio"),
 378       ...document.querySelectorAll("#ConnectionsDialogPane > checkbox"),
 379     ];
 380   },
 381
 382   // Update the UI to show/hide the extension controlled message for
 383   // proxy settings.
 384   async updateProxySettingsUI() {
 385     let isLocked = API_PROXY_PREFS.some(pref =>
 386       Services.prefs.prefIsLocked(pref)
 387     );
 388
 389     function setInputsDisabledState(isControlled) {
 390       for (let element of gConnectionsDialog.getProxyControls()) {
 391         element.disabled = isControlled;
 392       }
 393       gConnectionsDialog.proxyTypeChanged();
 394     }
 395
 396     if (isLocked) {
 397       // An extension can't control this setting if any pref is locked.
 398       hideControllingExtension(PROXY_KEY);
 399     } else {
 400       handleControllingExtension(PREF_SETTING_TYPE, PROXY_KEY).then(
 401         setInputsDisabledState
 402       );
 403     }
 404   },
 405
 406   registerSyncPrefListeners() {
 407     function setSyncFromPrefListener(element_id, callback) {
 408       Preferences.addSyncFromPrefListener(
 409         document.getElementById(element_id),
 410         callback
 411       );
 412     }
 413     setSyncFromPrefListener("networkProxyType", () => this.readProxyType());
 414     setSyncFromPrefListener("networkProxyHTTP", () =>
 415       this.readHTTPProxyServer()
 416     );
 417     setSyncFromPrefListener("networkProxyHTTP_Port", () =>
 418       this.readHTTPProxyPort()
 419     );
 420     setSyncFromPrefListener("shareAllProxies", () =>
 421       this.updateProtocolPrefs()
 422     );
 423     setSyncFromPrefListener("networkProxySSL", () =>
 424       this.readProxyProtocolPref("ssl", false)
 425     );
 426     setSyncFromPrefListener("networkProxySSL_Port", () =>
 427       this.readProxyProtocolPref("ssl", true)
 428     );
 429     setSyncFromPrefListener("networkProxySOCKS", () =>
 430       this.readProxyProtocolPref("socks", false)
 431     );
 432     setSyncFromPrefListener("networkProxySOCKS_Port", () =>
 433       this.readProxyProtocolPref("socks", true)
 434     );
 435   },
 436 };