exportFunction()

func

function. Die zu exportierende Funktion.

targetScope

object. Das Objekt, an das die Funktion angehängt werden soll. Dies muss nicht das globale window-Objekt sein; es könnte ein Objekt im Ziel-Fenster sein oder vom Aufrufer erstellt werden.

options Optional

object. Optionen für die Funktion.

defineAs Optional

string. Der Name der Funktion in targetScope. Wenn weggelassen, müssen Sie den Rückgabewert von exportFunction() einem Objekt im Zielbereich zuweisen.

allowCrossOriginArguments Optional

boolean. Ob überprüft werden soll, dass die Argumente der exportierten Funktion vom Aufrufer übernommen werden. Dies erlaubt dem Aufrufer, Objekte mit einem anderen Ursprung in die exportierte Funktion zu übergeben, die dann ihren privilegierten Status nutzen kann, um Cross-Origin-Anfragen mit dem Objekt zu stellen. Standardmäßig false.

Die Platzhalterfunktion, die im Zielkontext erstellt wurde.

Alle Argumente, die an die Funktion übergeben werden, werden nicht geklont. Stattdessen werden sie als Xrays in den privilegierten Bereich übergeben.

Ein Xray für ein Objekt bezieht sich auf das Original. Änderungen am Argument, die in der exportierten Funktion vorgenommen werden, beeinflussen das ursprüngliche übergebene Objekt. Zum Beispiel:

// privileged scope: for example, a content script
function changeMyName(user) {
  user.name = "Bill";
}
exportFunction(changeMyName, window, {
  defineAs: "changeMyName",
});

// less-privileged scope: for example, a page script
var user = { name: "Jim" };
var test = document.getElementById("test");
test.addEventListener(
  "click",
  function () {
    console.log(user.name); // "Jim"
    window.changeMyName(user);
    console.log(user.name); // "Bill"
  },
  false,
);

Dieses Verhalten unterliegt den normalen Regeln von Xrays. Zum Beispiel ist eine Expando-Eigenschaft, die einem DOM-Knoten hinzugefügt wird, im ursprünglichen Objekt nicht sichtbar.

Xrays bieten eine gefilterte Sicht auf das Originalobjekt. Beispielsweise sind Funktionen in den Xrays von JavaScript-Objekt-Typen nicht sichtbar. Wenn Sie ungefilterten Zugriff auf das Original benötigen, können Sie auf Xrays verzichten:

// privileged scope: for example, a content script
function logUser(user) {
  // console.log(user.getUser());                 // error
  console.log(user.wrappedJSObject.getUser()); // "Bill"
}
exportFunction(logUser, window, {
  defineAs: "logUser",
});

// less-privileged scope: for example, a page script
var user = {
  getUser: function () {
    return "Bill";
  },
};
var test = document.getElementById("test");
test.addEventListener(
  "click",
  function () {
    window.logUser(user);
  },
  false,
);

Weitere Informationen finden Sie unter Xray vision in der Firefox Source Tree-Dokumentation.

Wenn Funktionen als Argumente gegeben werden, werden diese ebenfalls als Xrays übergeben. Da Sie Function-Xrays wie normale Funktionen aufrufen können, bedeutet dies, dass das Übergeben von Rückruffunktionen in die exportierte Funktion funktioniert:

// privileged scope: for example, a content script
function logUser(getUser) {
  console.log(getUser()); // "Bill"
}
exportFunction(logUser, unsafeWindow, {
  defineAs: "logUser",
});

// less-privileged scope: for example, a page script
function getUser() {
  return "Bill";
}
var test = document.getElementById("test");
test.addEventListener(
  "click",
  function () {
    window.logUser(getUser);
  },
  false,
);

Wenn die exportierte Funktion aufgerufen wird, wird jedes Argument, einschließlich this, überprüft, um sicherzustellen, dass der Aufrufer das Argument übernimmt. Dies verhindert, dass plattformübergreifende Objekte (wie Window oder Location) an privilegierte Funktionen übergeben werden, da der privilegierte Code vollen Zugriff auf diese Objekte hat und unbeabsichtigt etwas Gefährliches tun könnte. Diese Bestimmung kann durch Übergeben von { allowCrossOriginArguments: true } an exportFunction außer Kraft gesetzt werden.

Dieses Skript definiert eine Funktion und exportiert sie dann in ein Inhaltsfenster:

// extension-script.js
var salutation = "hello ";
function greetMe(user) {
  return salutation + user;
}
exportFunction(greetMe, window, { defineAs: "foo" });

Anstatt defineAs zu verwenden, kann das Skript das Ergebnis von exportFunction einem Objekt im Zielbereich zuweisen:

// extension-script.js
var salutation = "hello ";
function greetMe(user) {
  return salutation + user;
}
window.foo = exportFunction(greetMe, window);

Auf beide Arten kann der Code, der im Geltungsbereich des Inhaltsfensters läuft, die Funktion aufrufen:

// page-script.js
var greeting = foo("alice");
console.log(greeting);
// "hello alice"

Anstatt die Funktion an das globale window-Objekt des Ziels anzuhängen, kann der Aufrufer sie an ein anderes Objekt im Zielkontext anhängen. Angenommen, das Inhaltsfenster definiert eine lokale Variable bar:

// page-script.js
var bar = {};

Nun kann das Erweiterungsskript die Funktion an bar anhängen:

// extension-script.js
exportFunction(greetMe, window.bar, {
  defineAs: "greetMe",
});

// page-script.js
var value = bar.greetMe("bob");
console.log(value);
// "hello bob"