使用内容脚本将代码插入页面上下文

2020/09/25 17:01 · javascript ·  · 0评论

我正在学习如何创建Chrome扩展程序。我刚刚开始开发一个捕捉YouTube事件的工具。我想将其与YouTube Flash Player结合使用(稍后,我将尝试使其与HTML5兼容)。

manifest.json:

{
    "name": "MyExtension",
    "version": "1.0",
    "description": "Gotta catch Youtube events!",
    "permissions": ["tabs", "http://*/*"],
    "content_scripts" : [{
        "matches" : [ "www.youtube.com/*"],
        "js" : ["myScript.js"]
    }]
}

myScript.js:

function state() { console.log("State Changed!"); }
var player = document.getElementById("movie_player");
player.addEventListener("onStateChange", "state");
console.log("Started!");

问题在于控制台为我提供了“开始!” ,但没有“状态已更改!” 当我播放/暂停YouTube视频时。

将此代码放入控制台后,它就可以工作。我究竟做错了什么?

潜在原因:

内容脚本在
“隔离的世界”环境中执行

解决方案:

要访问功能/页上下文(“主世界”),你必须注入想要访问他们进入网页本身代码的变量。
如果您想
您的函数/变量暴露给页面上下文(在您的情况下,这就是state()方法),也是如此。

请注意,如果chrome需要API

由于
chrome.*不能直接在公开页面脚本中使用API​​,因此您必须在内容脚本中使用它们,并通过特殊的DOM CustomEvent处理程序(例如一二)与公开页面脚本进行通信如果您不必使用chrome.*API,只需添加<script>如下所示标签,即可在页面中注入所有JS代码

安全警告

页面可能会重新定义或扩充/挂钩内置的原型,因此如果页面以不兼容的方式进行操作,则暴露的代码可能会失败。
如果您想确保公开的代码在安全的环境中运行,则应该a)使用
“ run_at”:“ document_start”声明内容脚本,并使用方法2-3而非1,或b)提取原始的本机内置例如,通过空的iframe插入请注意,document_start您可能需要使用DOMContentLoaded公开代码内部的事件来等待DOM。

目录

  • 方法1:注入另一个文件
  • 方法2:注入嵌入式代码
  • 方法2b:使用一个函数
  • 方法3:使用一个内联事件
  • 注入代码中的动态值

方法1:注入另一个文件

当您有很多代码时,这是最简单/最佳的方法。将您的实际JS代码包括在扩展名内的文件中,例如script.js然后,让您的内容脚本如下所示(此处说明:Google Chome“ Application Shortcut” Custom Javascript):

var s = document.createElement('script');
// TODO: add "script.js" to web_accessible_resources in manifest.json
s.src = chrome.runtime.getURL('script.js');
s.onload = function() {
    this.remove();
};
(document.head || document.documentElement).appendChild(s);

注意:出于安全原因,Chrome禁止加载js文件。您的文件必须作为"web_accessible_resources"项目添加例如):

// manifest.json must include: 
"web_accessible_resources": ["script.js"],

否则,控制台中将出现以下错误:

拒绝加载chrome-extension:// [EXTENSIONID] /script.js。必须在web_accessible_resources清单键中列出资源,以便由扩展之外的页面加载。

方法2:注入嵌入式代码

当您想快速运行一小段代码时,此方法很有用。(另请参见:如何使用Chrome扩展程序禁用Facebook热键?)。

var actualCode = `// Code here.
// If you want to use a variable, use $ and curly braces.
// For example, to use a fixed random number:
var someFixedRandomValue = ${ Math.random() };
// NOTE: Do not insert unsafe variables in this way, see below
// at "Dynamic values in the injected code"
`;

var script = document.createElement('script');
script.textContent = actualCode;
(document.head||document.documentElement).appendChild(script);
script.remove();

注意:模板文字仅在Chrome 41及更高版本中受支持。如果您希望扩展程序在Chrome 40-中运行,请使用:

var actualCode = ['/* Code here. Example: */' + 'alert(0);',
                  '// Beware! This array have to be joined',
                  '// using a newline. Otherwise, missing semicolons',
                  '// or single-line comments (//) will mess up your',
                  '// code ----->'].join('\n');

方法2b:使用一个函数

对于一大段代码,引用字符串是不可行的。除了使用数组,还可以使用函数并对其进行字符串化:

var actualCode = '(' + function() {
    // All code is executed in a local scope.
    // For example, the following does NOT overwrite the global `alert` method
    var alert = null;
    // To overwrite a global variable, prefix `window`:
    window.alert = null;
} + ')();';
var script = document.createElement('script');
script.textContent = actualCode;
(document.head||document.documentElement).appendChild(script);
script.remove();

此方法有效,因为+字符串和函数运算符会将所有对象转换为字符串。如果您打算多次使用该代码,则明智的做法是创建一个避免代码重复的函数。一个实现可能看起来像:

function injectScript(func) {
    var actualCode = '(' + func + ')();'
    ...
}
injectScript(function() {
   alert("Injected script");
});

注意:由于该函数已序列化,因此原始作用域和所有绑定的属性都将丢失!

var scriptToInject = function() {
    console.log(typeof scriptToInject);
};
injectScript(scriptToInject);
// Console output:  "undefined"

方法3:使用一个内联事件

有时,您想立即运行一些代码,例如,在<head>创建元素之前运行一些代码这可以通过使用插入<script>标签来完成textContent(请参见方法2 / 2b)。

一种替代方法,但不建议使用内联事件。不建议这样做,因为如果页面定义了禁止内联脚本的内容安全策略,则内联事件侦听器将被阻止。另一方面,扩展程序注入的内联脚本仍在运行。如果您仍想使用内联事件,则可以这样:

var actualCode = '// Some code example \n' + 
                 'console.log(document.documentElement.outerHTML);';

document.documentElement.setAttribute('onreset', actualCode);
document.documentElement.dispatchEvent(new CustomEvent('reset'));
document.documentElement.removeAttribute('onreset');

注意:此方法假定没有其他全局事件侦听器来处理该reset事件。如果存在,您还可以选择其他全局事件之一。只需打开JavaScript控制台(F12),输入document.documentElement.on,然后选择可用的事件即可。

注入代码中的动态值

有时,您需要将任意变量传递给注入的函数。例如:

var GREETING = "Hi, I'm ";
var NAME = "Rob";
var scriptToInject = function() {
    alert(GREETING + NAME);
};

要注入此代码,您需要将变量作为参数传递给匿名函数。确保正确实施!下面将工作:

var scriptToInject = function (GREETING, NAME) { ... };
var actualCode = '(' + scriptToInject + ')(' + GREETING + ',' + NAME + ')';
// The previous will work for numbers and booleans, but not strings.
// To see why, have a look at the resulting string:
var actualCode = "(function(GREETING, NAME) {...})(Hi, I'm ,Rob)";
//                                                 ^^^^^^^^ ^^^ No string literals!

解决方案是JSON.stringify在传递参数之前使用例:

var actualCode = '(' + function(greeting, name) { ...
} + ')(' + JSON.stringify(GREETING) + ',' + JSON.stringify(NAME) + ')';

如果您有许多变量,则值得使用JSON.stringify一次以提高可读性,如下所示:

...
} + ')(' + JSON.stringify([arg1, arg2, arg3, arg4]) + ')';

唯一的事情 失踪 Rob W出色的答案隐藏的是如何在注入的页面脚本和内容脚本之间进行通信。

在接收方(您的内容脚本或注入的页面脚本)上添加一个事件侦听器:

document.addEventListener('yourCustomEvent', function (e) {
  var data = e.detail;
  console.log('received', data);
});

在启动器端(内容脚本或注入的页面脚本)发送事件:

var data = {
  allowedTypes: 'those supported by structured cloning, see the list below',
  inShort: 'no DOM elements or classes/functions',
};

document.dispatchEvent(new CustomEvent('yourCustomEvent', { detail: data }));

笔记:

  • DOM消息传递使用结构化克隆算法,该算法除了原始值外还只能传输某些类型的数据它不能发送类实例或函数或DOM元素。
  • 在Firefox中,要将对象(即非原始值)从内容脚本发送到页面上下文,您必须使用cloneInto(内置函数)将其显式克隆到目标中,否则它将因安全冲突错误而失败。

    document.dispatchEvent(new CustomEvent('yourCustomEvent', {
      detail: cloneInto(data, document.defaultView),
    }));
    

我还遇到了加载脚本排序的问题,该问题通过顺序加载脚本解决。加载基于Rob W的答案

function scriptFromFile(file) {
    var script = document.createElement("script");
    script.src = chrome.extension.getURL(file);
    return script;
}

function scriptFromSource(source) {
    var script = document.createElement("script");
    script.textContent = source;
    return script;
}

function inject(scripts) {
    if (scripts.length === 0)
        return;
    var otherScripts = scripts.slice(1);
    var script = scripts[0];
    var onload = function() {
        script.parentNode.removeChild(script);
        inject(otherScripts);
    };
    if (script.src != "") {
        script.onload = onload;
        document.head.appendChild(script);
    } else {
        document.head.appendChild(script);
        onload();
    }
}

用法示例为:

var formulaImageUrl = chrome.extension.getURL("formula.png");
var codeImageUrl = chrome.extension.getURL("code.png");

inject([
    scriptFromSource("var formulaImageUrl = '" + formulaImageUrl + "';"),
    scriptFromSource("var codeImageUrl = '" + codeImageUrl + "';"),
    scriptFromFile("EqEditor/eq_editor-lite-17.js"),
    scriptFromFile("EqEditor/eq_config.js"),
    scriptFromFile("highlight/highlight.pack.js"),
    scriptFromFile("injected.js")
]);

其实,我是JS的新手,所以随时向我推荐更好的方法。

在Content脚本中,我将脚本标签添加到绑定“ onmessage”处理程序的头部,在我使用的处理程序内部,eval执行代码。在展位内容脚本中,我也使用onmessage处理程序,因此我得到了两种通信方式。
Chrome文件

//Content Script

var pmsgUrl = chrome.extension.getURL('pmListener.js');
$("head").first().append("<script src='"+pmsgUrl+"' type='text/javascript'></script>");


//Listening to messages from DOM
window.addEventListener("message", function(event) {
  console.log('CS :: message in from DOM', event);
  if(event.data.hasOwnProperty('cmdClient')) {
    var obj = JSON.parse(event.data.cmdClient);
    DoSomthingInContentScript(obj);
 }
});

pmListener.js是一个帖子URL侦听器

//pmListener.js

//Listen to messages from Content Script and Execute Them
window.addEventListener("message", function (msg) {
  console.log("im in REAL DOM");
  if (msg.data.cmnd) {
    eval(msg.data.cmnd);
  }
});

console.log("injected To Real Dom");

这样,我就可以在CS与Real Dom之间进行2路通信。例如,如果您需要侦听webscoket事件或内存中的任何变量或事件,它非常有用。

您可以使用我创建的实用程序函数,以便在页面上下文中运行代码并获取返回值。

这是通过将函数序列化为字符串并将其注入到网页来完成的。

该实用程序可在GitHub上找到

用法示例-



// Some code that exists only in the page context -
window.someProperty = 'property';
function someFunction(name = 'test') {
    return new Promise(res => setTimeout(()=>res('resolved ' + name), 1200));
}
/////////////////

// Content script examples -

await runInPageContext(() => someProperty); // returns 'property'

await runInPageContext(() => someFunction()); // returns 'resolved test'

await runInPageContext(async (name) => someFunction(name), 'with name' ); // 'resolved with name'

await runInPageContext(async (...args) => someFunction(...args), 'with spread operator and rest parameters' ); // returns 'resolved with spread operator and rest parameters'

await runInPageContext({
    func: (name) => someFunction(name),
    args: ['with params object'],
    doc: document,
    timeout: 10000
} ); // returns 'resolved with params object'


如果要注入纯函数而不是文本,可以使用以下方法:

function inject(){
    document.body.style.backgroundColor = 'blue';
}

// this includes the function as text and the barentheses make it run itself.
var actualCode = "("+inject+")()"; 

document.documentElement.setAttribute('onreset', actualCode);
document.documentElement.dispatchEvent(new CustomEvent('reset'));
document.documentElement.removeAttribute('onreset');

您可以将参数(不幸的是,不能将对象和数组进行字符串化)传递给函数。将其添加到裸机中,如下所示:

function inject(color){
    document.body.style.backgroundColor = color;
}

// this includes the function as text and the barentheses make it run itself.
var color = 'yellow';
var actualCode = "("+inject+")("+color+")"; 
本文地址:http://javascript.askforanswer.com/shiyongneirongjiaobenjiangdaimacharuyemianshangxiawen.html
文章标签: ,   ,   ,   ,  
版权声明:本文为原创文章,版权归 javascript 所有,欢迎分享本文,转载请保留出处!

文件下载

老薛主机终身7折优惠码boke112

上一篇:
下一篇:

评论已关闭!