proxy.register()

Vous pouvez échanger des messages entre le fichier PAC et la page d'arrière-plan de votre extension (ou toute autre page privilégiée, comme les pages contextuelles) en utilisant runtime.sendMessage() et runtime.onMessage.

Pour envoyer un message au fichier PAC, vous devez définir l'option toProxyScript :

// background.js

// Log any messages from the proxy.
browser.runtime.onMessage.addListener((message, sender) => {
  if (sender.url === browser.extension.getURL(proxyScriptURL)) {
    console.log(message);
  }
});

let messageToProxy = {
  enabled: true,
  foo: "A string",
  bar: 1234
};

browser.runtime.sendMessage(messageToProxy, {toProxyScript: true});

// pac.js

browser.runtime.onMessage.addListener((message) => {
  if (message.enabled) {
    browser.runtime.sendMessage("I'm enabled!");
  }
});

La syntaxe de base du fichier PAC est décrite dans la documentation PAC (en-US), mais l'implémentation utilisée par l'API proxy diffère de la conception PAC standard de différentes manières, décrites dans cette section.

La norme FindProxyForURL() renvoie une chaîne (en-US). Dans Firefox 55 et 56, le fichier PAC utilisé avec l'API proxy renvoie également une chaîne. Dans Firefox 55 seulement, vous devez passer un argument à la valeur de retour "DIRECT", même s'il n'a pas besoin d'argument.

À partir de Firefox 57, FindProxyForURL() peut toujours renvoyer une chaîne, mais peut également (et de préférence) renvoyer un tableau d'objets proxy.ProxyInfo.

Si le tableau contient plus d'un objet, alors tous les objets ProxyInfo après le premier représentent les basculements : si le proxy à la position N dans le tableau n'est pas accessible quand son ProxyInfo.failoverTimeout expire, alors le navigateur essaiera le proxy à la position N + 1.

Par exemple :

const proxySpecification = [
  {
    type: "socks",
    host: "foo.com",
    port: 1080,
    proxyDNS: true,
    failoverTimeout: 5
  },
  {
    type: "socks",
    host: "bar.com",
    port: 1060,
  }
];

Le premier proxy dans le tableau sera essayé en premier. S'il ne répond pas dans failoverTimeout secondes, le prochain sera essayé, jusqu'à ce que la fin du tableau est atteint.

Les fonctions globales d'assistance généralement disponibles pour les fichiers PAC (isPlainHostName() (en-US), dnsDomainIs() (en-US), etc) ne sont pas disponibles.

Le code qui s'exécute dans le fichier PAC n'a pas accès à :

• outes les fonctions DOM (par exemple, window ou l'une de ses propriétés)
• les API WebExtension sauf runtime.sendMessage() et runtime.onMessage
• l' API console - pour consigner les messages d'un PAC, envoyez un message au script d'arrière-plan :

//  pac.js

// send the log message to the background script
browser.runtime.sendMessage(`Proxy-blocker: blocked ${url}`);

// background-script.js

function handleMessage(message, sender) {
  // only handle messages from the proxy script
  if (sender.url != browser.extension.getURL(proxyScriptURL)) {
    return;
  }
  console.log(message);
}

browser.runtime.onMessage.addListener(handleMessage);

url

String. URL pointant vers le fichier PAC à charger. Les fichiers PAC doivent être groupés avec l'extension, et l'url doit être relative au fichier manifest.json de l'extension.

Une Promise qui sera remplie sans argument lorsque le fichier PAC a été enregistré ou rejetée en cas d'erreur.