webRequest.onBeforeRequest

Syntax

browser.webRequest.onBeforeRequest.addListener(
  listener,             // function
  filter,               //  object
  extraInfoSpec         //  optional array of strings
)
browser.webRequest.onBeforeRequest.removeListener(listener)
browser.webRequest.onBeforeRequest.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener, filter, extraInfoSpec)

Fügt diesem Ereignis einen Listener hinzu.

removeListener(listener)

Stoppt das Zuhören auf dieses Ereignis. Das listener Argument ist der zu entfernende Listener.

hasListener(listener)

Überprüfen, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn es zuhört, ansonsten false.

addListener Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis auftritt. Die Funktion wird mit folgendem Argument übergeben:

details

object. Details zur Anfrage. Siehe den Details Abschnitt für weitere Informationen.

Rückgaben: webRequest.BlockingResponse. Wenn "blocking" im extraInfoSpec Parameter angegeben ist, sollte der Event-Listener ein BlockingResponse Objekt zurückgeben und kann entweder seine Eigenschaften cancel oder redirectUrl festlegen. Ab Firefox 52 kann der Listener anstelle der Rückgabe von BlockingResponse ein Promise zurückgeben, das mit einem BlockingResponse aufgelöst wird. Dies ermöglicht es dem Listener, die Anfrage asynchron zu verarbeiten.

filter

webRequest.RequestFilter. Ein Filter, der die an diesen Listener gesendeten Ereignisse einschränkt.

extraInfoSpec Optional

array aus string. Zusätzliche Optionen für das Ereignis. Sie können einen der folgenden Werte übergeben:

• "blocking": macht die Anfrage synchron, sodass Sie die Anfrage abbrechen oder umleiten können.
• "requestBody": schließt requestBody im an den Listener übergebenen details Objekt ein.

Zusätzliche Objekte

details

documentId Optional

string. Die UUID des Dokuments, das die Anfrage stellt. Lesen Sie den Artikel Arbeiten mit documentId, um mehr zu erfahren.

documentLifecycle

string. Der Lebenszyklus, in dem sich das Dokument befindet. Gibt die Werte "prerender", "active", "cached", oder "pending_deletion" zurück.

cookieStoreId

string. Wenn die Anfrage von einem Tab geöffnet wird, der sich in einer kontextuellen Identität befindet, ist dies die Cookie-Store-ID dieser kontextuellen Identität. Weitere Informationen finden Sie unter Arbeiten mit kontextuellen Identitäten.

documentUrl

string. URL des Dokuments, in dem die Ressource geladen wird. Beispiel: Wenn die Webseite unter "https://example.com" ein Bild oder ein iframe enthält, dann wird die documentUrl für das Bild oder das iframe "https://example.com" sein. Für ein Top-Level-Dokument ist documentUrl undefiniert.

frameAncestors

array. Enthält Informationen für jedes Dokument in der Rahmenhierarchie bis zum obersten Dokument. Das erste Element im Array enthält Informationen über das unmittelbare übergeordnete Dokument des angeforderten Dokuments, und das letzte Element enthält Informationen über das oberste Dokument. Wenn das Laden tatsächlich für das Top-Level-Dokument erfolgt, ist dieses Array leer.

url

string. Die URL, von der das Dokument geladen wurde.

frameId

integer. Die frameId des Dokuments. details.frameAncestors[0].frameId entspricht details.parentFrameId.

frameId

integer. Null, wenn die Anfrage im Hauptframe passiert; ein positiver Wert ist die ID eines Unterrahmens, in dem die Anfrage passiert. Wenn das Dokument eines (Unter-)Rahmens geladen wird (type ist main_frame oder sub_frame), gibt frameId die ID dieses Rahmens an, nicht die ID des äußeren Rahmens. Rahmen-IDs sind innerhalb eines Tabs eindeutig.

frameType

string. Der Typ des Rahmens, in dem die Anfrage stattgefunden hat. Gibt die Werte "outermost_frame", "fenced_frame", oder "sub_frame" zurück.

incognito

boolean. Ob die Anfrage aus einem privaten Fenster stammt.

method

string. Standard HTTP-Methode: zum Beispiel "GET" oder "POST".

originUrl

string. URL der Ressource, die die Anfrage ausgelöst hat. Beispiel: Wenn "https://example.com" einen Link enthält, und der Benutzer klickt darauf, dann ist die originUrl für die resultierende Anfrage "https://example.com".

Die originUrl ist oft, aber nicht immer, dieselbe wie die documentUrl. Beispiel: Wenn eine Seite ein iframe enthält und das iframe einen Link enthält, der ein neues Dokument ins iframe lädt, ist die documentUrl für die resultierende Anfrage das übergeordnete Dokument des iframe, aber die originUrl ist die URL des Dokuments im iframe, das den Link enthielt.

parentDocumentId Optional

string. Eine UUID des übergeordneten Dokuments, dem der Rahmen gehört. Nicht gesetzt, wenn kein übergeordnetes Dokument vorhanden ist. Lesen Sie den Artikel Arbeiten mit documentId, um mehr zu erfahren.

parentFrameId

integer. Die ID des Rahmens, das den Rahmen enthält, der die Anfrage gesendet hat. Setzt -1, wenn kein übergeordneter Rahmen existiert.

proxyInfo

object. Diese Eigenschaft ist nur vorhanden, wenn die Anfrage über einen Proxy läuft. Sie enthält die folgenden Eigenschaften:

host

string. Der Hostname des Proxy-Servers.

port

integer. Die Portnummer des Proxy-Servers.

type

string. Der Typ des Proxy-Servers. Eine von:

• "http": HTTP-Proxy (oder SSL CONNECT für HTTPS)
• "https": HTTP-Proxydienste über TLS-Verbindung zum Proxy
• "socks": SOCKS v5 Proxy
• "socks4": SOCKS v4 Proxy
• "direct": keine Proxy-Verwendung
• "unknown": unbekannter Proxy

username

string. Benutzername für den Proxydienst.

proxyDNS

boolean. True, wenn der Proxy die DNS-Auflösung basierend auf dem bereitgestellten Hostnamen durchführt, was bedeutet, dass der Client keine eigene DNS-Abfrage durchführen sollte.

failoverTimeout

integer. Failover-Zeitüberschreitung in Sekunden. Wenn die Proxy-Verbindung fehlschlägt, wird der Proxy für diese Zeitspanne nicht mehr verwendet.

requestBody Optional

object. Enthält die HTTP-Anfrage-Body-Daten. Wird nur bereitgestellt, wenn extraInfoSpec "requestBody" enthält.

error Optional

string. Dies wird gesetzt, wenn beim Abrufen der Anfrage-Body-Daten Fehler aufgetreten sind.

formData Optional

object. Dieses Objekt ist vorhanden, wenn die Anfrage-Methode POST ist und der Body eine Sequenz von Schlüssel-Wert-Paaren ist, die in UTF-8 entweder als "multipart/form-data" oder "application/x-www-form-urlencoded" kodiert sind.

Es ist ein Wörterbuch, in dem jeder Schlüssel die Liste aller Werte für diesen Schlüssel enthält. Zum Beispiel: {'key': ['value1', 'value2']}. Wenn die Daten einen anderen Medientyp haben oder fehlerhaft sind, ist das Objekt nicht vorhanden.

raw Optional

array von webRequest.UploadData. Wenn die Anfrage-Methode PUT oder POST ist und der Body nicht bereits in formData analysiert ist, dann enthält dieses Array die nicht analysierten Anfrage-Body-Elemente.

requestId

string. Die ID der Anfrage. Anfragen-IDs sind innerhalb einer Browser-Sitzung eindeutig, sodass Sie sie verwenden können, um verschiedene Ereignisse zu verknüpfen, die mit derselben Anfrage verbunden sind.

tabId

integer. Die ID des Tabs, in dem die Anfrage stattfindet. Setzt -1, wenn die Anfrage nicht mit einem Tab zusammenhängt.

thirdParty

boolean. Gibt an, ob die Anfrage und ihre Inhaltsfenster-Hierarchie Drittanbieter sind.

timeStamp

number. Die Zeit, zu der dieses Ereignis ausgelöst wurde, in Millisekunden seit der Epoche.

type

webRequest.ResourceType. Der Typ der Ressource, die angefordert wird, z.B. "image", "script", "stylesheet".

url

string. Ziel der Anfrage.

urlClassification

object. Die Art des Trackings, das mit der Anfrage verbunden ist, wenn die Anfrage durch den Firefox-Tracking-Schutz klassifiziert wurde. Dies ist ein Objekt mit diesen Eigenschaften:

firstParty

array von string. Klassifikationskennzeichen für den First Party der Anfrage.

thirdParty

array von string. Klassifikationskennzeichen für die Anfrage oder die Hierarchie des Inhaltsfensters von Drittanbietern.

Die Klassifikationskennzeichen umfassen:

• fingerprinting und fingerprinting_content: gibt an, dass die Anfrage in das Fingerprinting verwickelt ist ("ein Ursprung, der zum Fingerprinting gefunden wurde").
  • fingerprinting zeigt an, dass die Domain in der Kategorie Fingerprinting und Tracking ist. Beispiele für diese Art von Domain sind Werbetreibende, die ein Profil mit dem besuchenden Benutzer verknüpfen möchten.
  • fingerprinting_content zeigt an, dass die Domain in der Fingerprinting-Kategorie, jedoch nicht in der Tracking-Kategorie ist. Beispiele für diese Art von Domain sind Zahlungsanbieter, die Fingerprinting-Techniken verwenden, um den besuchenden Benutzer zur Betrugsbekämpfung zu identifizieren.
• cryptomining und cryptomining_content: ähnlich der Fingerprinting-Kategorie, jedoch für Krypto-Mining-Ressourcen.
• tracking, tracking_ad, tracking_analytics, tracking_social, und tracking_content: gibt an, dass die Anfrage mit Verfolgung verbunden ist. tracking ist jede generische Verfolgungsanfrage, die Suffixe ad, analytics, social, und content identifizieren die Art des Trackers.
• emailtracking und emailtracking_content: gibt an, dass die Anfrage mit der Verfolgung von E-Mails verbunden ist.
• any_basic_tracking: ein Meta-Kennzeichen, das Tracking- und Fingerprinting-Kennzeichen kombiniert, außer tracking_content und fingerprinting_content.
• any_strict_tracking: ein Meta-Kennzeichen, das alle Tracking- und Fingerprinting-Kennzeichen kombiniert.
• any_social_tracking: ein Meta-Kennzeichen, das alle sozialen Tracking-Kennzeichen kombiniert.

Weitere Informationen zu Tracker-Typen finden Sie auf der Website von disconnect.me. Das Suffix content gibt Tracker an, die Inhalte verfolgen und bereitstellen. Das Blockieren bringt Schutz, kann jedoch dazu führen, dass Seiten oder Elemente nicht angezeigt werden.

DNS-Auflösungsreihenfolge, wenn BlockingResponse verwendet wird

Bezüglich der DNS-Auflösung, wenn BlockingResponse mit OnBeforeRequest verwendet wird: Im HTTP-Kanal passiert onBeforeRequest mit einer blockierenden Antwort vor der DNS-Auflösung und auch vor dem spekulativen Verbindungsaufbau. Für andere Kanäle könnte der spekulative Verbindungsaufbau dazu führen, dass DNS-Anfragen vor onBeforeRequest stattfinden. Diese Reihenfolge ist nichts, worauf sich ein Erweiterungsentwickler verlassen sollte, da sie sich zwischen Browsern und zwischen einer Browser-Version und der nächsten ändern kann, geschweige denn zwischen einem Anforderungskanal und einem anderen. Siehe die BugZilla-Issue-Klarstellung, die von Mozilla-Entwicklern zur DNS-Auflösungsreihenfolge bereitgestellt wurde.

Beispiele

Dieser Code protokolliert die URL für jede Ressource, die angefragt wird und die dem <all_urls> Muster entspricht:

function logURL(requestDetails) {
  console.log(`Loading: ${requestDetails.url}`);
}

browser.webRequest.onBeforeRequest.addListener(logURL, {
  urls: ["<all_urls>"],
});

Dieser Code bricht Anfragen für Bilder ab, die zu URLs unter "https://developer.mozilla.org/" gemacht werden (um den Effekt zu sehen, besuchen Sie eine beliebige Seite auf MDN, die Bilder enthält, wie z.B. webRequest):

// match pattern for the URLs to redirect
let pattern = "https://developer.mozilla.org/*";

// cancel function returns an object
// which contains a property `cancel` set to `true`
function cancel(requestDetails) {
  console.log(`Canceling: ${requestDetails.url}`);
  return { cancel: true };
}

// add the listener,
// passing the filter argument and "blocking"
browser.webRequest.onBeforeRequest.addListener(
  cancel,
  { urls: [pattern], types: ["image"] },
  ["blocking"],
);

Dieser Code ersetzt durch Umleitung alle Netzwerk-Anfragen für Bilder, die zu URLs unter "https://developer.mozilla.org/" gemacht werden (um den Effekt zu sehen, besuchen Sie jede Seite bei MDN, die Bilder enthält, wie z.B. webRequest):

// match pattern for the URLs to redirect
let pattern = "https://developer.mozilla.org/*";

// redirect function
// returns an object with a property `redirectURL`
// set to the new URL
function redirect(requestDetails) {
  console.log(`Redirecting: ${requestDetails.url}`);
  return {
    redirectUrl:
      "https://38.media.tumblr.com/tumblr_ldbj01lZiP1qe0eclo1_500.gif",
  };
}

// add the listener,
// passing the filter argument and "blocking"
browser.webRequest.onBeforeRequest.addListener(
  redirect,
  { urls: [pattern], types: ["image"] },
  ["blocking"],
);

Dieser Code ist genau wie das vorherige Beispiel, außer dass der Listener die Anfrage asynchron behandelt. Er gibt ein Promise zurück, das einen Timer setzt und die Umleitungs-URL auflöst, wenn der Timer abläuft:

// match pattern for the URLs to redirect
let pattern = "https://developer.mozilla.org/*";

// URL we will redirect to
let redirectUrl =
  "https://38.media.tumblr.com/tumblr_ldbj01lZiP1qe0eclo1_500.gif";

// redirect function returns a Promise
// which is resolved with the redirect URL when a timer expires
function redirectAsync(requestDetails) {
  console.log(`Redirecting async: ${requestDetails.url}`);
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve({ redirectUrl });
    }, 2000);
  });
}

// add the listener,
// passing the filter argument and "blocking"
browser.webRequest.onBeforeRequest.addListener(
  redirectAsync,
  { urls: [pattern], types: ["image"] },
  ["blocking"],
);

Ein weiteres Beispiel, das alle Bilder zu einer Daten-URL umleitet:

let pattern = "https://developer.mozilla.org/*";

let image = `
  <svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%">
    <rect style="stroke-width: 10; stroke: #666666;" width="100%" height="100%" fill="#d4d0c8" />
    <text transform="translate(0, 9)" x="50%" y="50%" width="100%" fill="#666666" height="100%" style="text-anchor: middle; font: bold 10pt 'Segoe UI', Arial, Helvetica, Sans-serif;">Blocked</text>
  </svg>
`;

function listener(details) {
  const redirectUrl = `data:image/svg+xml,${encodeURIComponent(image)}`;
  return { redirectUrl };
}

browser.webRequest.onBeforeRequest.addListener(
  listener,
  { urls: [pattern], types: ["image"] },
  ["blocking"],
);

Hier ist eine weitere Version:

function randomColor() {
  return `#${Math.floor(Math.random() * 16777215).toString(16)}`;
}

const pattern = "https://developer.mozilla.org/*";

let image = `
  <svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%">
    <rect width="100%" height="100%" fill="${randomColor()}"/>
  </svg>
`;

function listener(details) {
  const redirectUrl = `data:image/svg+xml,${encodeURIComponent(image)}`;
  return { redirectUrl };
}

browser.webRequest.onBeforeRequest.addListener(
  listener,
  { urls: [pattern], types: ["image"] },
  ["blocking"],
);

Beispielerweiterungen

• http-response

Browser-Kompatibilität