Firefox插件中的脚本之间的通信sdk - self.port不存在

时间:2013-05-28 20:51:04

标签: javascript firefox firefox-addon firefox-addon-sdk

我正在尝试使用他们的sdk创建一个firefox插件,但我不知道如何让我的js脚本进行通信。目标是制作一个带有表格的面板,有3个复选框,选中后可以隐藏/显示活动选项卡上的某些元素。

以下是脚本: main.js:

var data = require("sdk/self").data;

var painel1 = require("sdk/panel").Panel({
    width: 215,
    height: 160,
    contentURL: data.url("painelDestroyer.html"),
    contentScriptFile: [data.url("jquery.js"),data.url("panel.js")]
});

require("sdk/widget").Widget({
    id: "open-form-btn",
    label: "Clear",
    contentURL: data.url("mozico.png"),
    panel: painel1
});

// Attach a content script to the current active tab
let worker = require("sdk/tabs").activeTab.attach({
    contentScriptFile: data.url("clear.js")
});


painel1.port.on("show-tag",function(tag){
    worker.port.emit("show-tag", {tag:tag});
    console.log("worker emited");
});

painel1.port.on("hide-tag",function(tag){
    worker.port.emit("clear-tag", {tag:tag});
    console.log("worker emited");
});

painel.js:

$("#imgD").click(function() {
    if ($(this).is(":checked")) {
        panel.port.emit("clear-tag","img");
        console.log("panel emited");
    } else {
       panel.port.emit("show-tag","img");
       console.log("panel emited");
    }
});
$("#aD").click(function() {
    if ($(this).is(":checked")) {
        panel.port.emit("clear-tag","a");
        console.log("panel emited");
    } else {
        panel.port.emit("show-tag","a");
        console.log("panel emited");
    }
});
$("#iframeD").click(function() {
    if ($(this).is(":checked")) {
       panel.port.emit("clear-tag","iframe");
       console.log("panel emited");
    } else {
        panel.port.emit("show-tag","iframe");
        console.log("panel emited");
    }
});

clear.js:

    function tagHide (tag, hide) {
    $(tag).each(function() {
        if (hide === false) {
            $(this).css({
                "visibility": "visible"
            });
        } else {
            $(this).css({
                "visibility": "hidden"
            });
        }
    });
}

self.port.on('show-tag', function(tag) {
    tagHide(tag, false);
});
self.port.on('clear-tag', function(tag) {
    tagHide(tag, true);
});

问题:如何使这项工作,如何在这三个脚本之间进行通信?我的猜测是我必须从painel.js发送消息到main.js然后发送到clean.js,但是我该怎么做?如何在clean.js或painel.js中收到消息? 我一直认为,painel.js中不存在self.port。

1 个答案:

答案 0 :(得分:5)

问题是您尝试从模块脚本而不是内容脚本访问和修改页面内容。模块脚本范围内没有windowdocument,如the documentation中所述。因此,jQuery的$将无法在您的加载项脚本中使用任何内容。

您需要attach另一个内容脚本到当前标签。然后,您可以通过向其工作端口发送消息来显示/隐藏页面上的元素,类似于您在附加模块脚本和面板脚本之间进行通信的方式。

// Attach a content script to the current active tab
let worker = require("sdk/tabs").activeTab.attach({
    contentScriptFile: data.url("tabscript.js")
});
// Send it a message
worker.port.emit("show-tag", tag);

然后,您可以将tagHide函数移动到活动选项卡的内容脚本,并在其中放置一些端口侦听器。这样,加载项脚本可以发出一些消息,并使内容脚本适当地调用tagHide

注意:您最好使用page-mod而不是附加到标签页。最后,您可能不希望每次用户导航到其他页面时手动附加脚本,因此全局PageMod(include: "*")是一个简单的解决方案。不过,在转发邮件时,您需要确保定位当前标签的工作人员。因此,您需要跟踪所有这些工作人员和clean them up when the worker is detached(使用worker.on('detach', callback)。最后,您应该遍历所有当前连接的工作人员并找到附加到当前活动选项卡页面的工作人员(通过比较每个worker.tabtabs.activeTab)。

或者,您可以直接将命令作为JavaScript注入标签页,如Attaching Content Scripts to Tabs所示。我觉得这很难看,并且它不允许你在内容脚本中保留一些状态(跨命令保留的页面上的变量),这些状态可能是更复杂的脚本所需要的。

更新1 :至于您更新的问题,答案是very well documented in the SDK guides。您只需使用self.port.on

绑定侦听器
self.port.on('show-tag', function(tag) {
    tagHide(tag, false);
});
self.port.on('clear-tag', function(tag) {
    tagHide(tag);
});

另一方面,当加载项启动时,您当前的代码只能使用当前活动的选项卡。最有可能的是,活动标签会发生变化,您需要随着时间的推移将内容脚本注入其他标签。请参阅我之前关于您如何管理所有这些脚本的工作人员的说明。