I am pretty new in the Chrome Extensions field.
I am trying to build an extension to visit some websites and collect information from their HTML.
I am having a hard time getting chrome.scripting.executeScript working properly.
Source Code
manifest.json
{
"name": "Scraper",
"description": "Simple Extension to Scrape Websites, and Push Them to ConnectionSphere for Data Enrichment",
"version": "2.0",
"permissions": ["storage", "webRequest", "scripting", "declarativeContent", "activeTab", "tabs", "downloads", "*://*/*", "http://connectionsphere.com:80/*", "http://connectionsphere.com/api1.0/emails/verify.json"],
"host_permissions": [ "https://www.amazon.com/*", "https://connectionsphere.com/*", "https://github.com/*" ],
"manifest_version": 3,
"icons": {
"48": "/48.png",
"128": "/128.png"
},
"action": {
"default_popup": "popup.html",
"default_icon": {
"48": "/48.png",
"128": "/128.png"
}
}
}
popup.html
<!DOCTYPE html>
<html>
<head>
<title>Scraper</title>
</head>
<body>
<div id="notify-wrapper">
<div id="notify-header">
<h1>Scraper!</h1>
</div>
<div id="notify-containers">
<div class="login-form">
<input type="button" id="start" name="start" value="Start" />
<p id="text" name="text"></p>
</div>
</div>
<script src="popup.js"></script>
</body>
</html>
popup.js
'use strict';
let text = document.getElementById('text');
function upload_page() {
alert('b');
document.body.innerHTML = 'hola';
return document.title;
}
start.onclick = function() {
let page_url_value = 'https://github.com/';
text.innerHTML = 'Scraping page...';
chrome.tabs.query({active: true, currentWindow: true}, async function(tabs) {
// get the tab id
var tab_id = tabs[0].id;
// go to the page
chrome.tabs.update({url: page_url_value});
// fired when tab is updated
chrome.tabs.onUpdated.addListener(function openPage(tabID, changeInfo) {
// tab has finished loading
if(tab_id == tabID && changeInfo.status === 'complete') {
// remove tab onUpdate event as it may get duplicated
chrome.tabs.onUpdated.removeListener(openPage);
// execute content script
alert('a');
chrome.scripting.executeScript(
{
target: {tabId: tab_id, allFrames: true},
func: upload_page
},
// Get the value returned by do_login.
// Reference: https://developer.chrome.com/docs/extensions/reference/scripting/#handling-results
(injectionResults) => {
for (const frameResult of injectionResults)
text.innerHTML = frameResult.result;
}
);
}
});
});
};
The Problem
When the user clicks on the "start" button of the popup, the extension visits a page and calls chrome.scripting.executeScript to run a function that works with the DOM of such a page. But such execution is not performed (thealert('a') happens, but the alert('b') is never executed).
If I refresh the page manually from the browser and click on the "start" button again, then the chrome.scripting.executeScript runs.
I researched for an answer into other posts here, but I didn't find anything.
The answers in this post didn't help me.
I wrote a small test-unit to show the problem I am facing.
It worked after I removed the extension and added it again. Thanks!
Related
I got the extension to add "dev." to the current URL in a new tab which is working through a pop-up.
I'm trying to disable/remove the pop-up so that the code will work only when pressing the extension button instead.
popup.js:
document.addEventListener("DOMContentLoaded", function() {
console.log("Extension button clicked!");
var button = document.getElementById("change-url");
button.addEventListener("click", function() {
chrome.tabs.query({ active: true, currentWindow: true }, function(tabs) {
var url = new URL(tabs[0].url);
url.hostname = "dev." + url.hostname;
chrome.tabs.create({ url: url.toString() });
});
});
});
manifest.json:
{
"name": "My URL Changer",
"version": "1.0",
"manifest_version": 3,
"permissions": ["scripting"],
"host_permissions": ["<all_urls>"],
"action": {
"default_popup": "popup.html",
"default_title": "My URL Changer"
}
}
popup.html:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>My URL Changer</title>
<script src="popup.js"></script>
</head>
<body>
<h1>My URL Changer</h1>
<button id="change-url">Change URL</button>
</body>
</html>
As woxxom mentioned, the chrome.action.onClicked API is a good fit for this.
The event does not fire if the extension has a popup, so you'll want to remove the default_popup key. However, you'll need to keep the empty action object. This tells Chrome to show an icon for your extension and is also required to make the API available.
With those changes in mind, your manifest would look like this:
{
"name": "My URL Changer",
"version": "1.0",
"manifest_version": 3,
"permissions": [
"scripting"
],
"host_permissions": [
"<all_urls>"
],
"action": {}
}
You should also consider removing <all_urls> and replacing it with just the domains you want your extension to run on, since it's always best to request just the access you need. You could also remove this key entirely and use the activeTab permission instead, which gives your extension access to pages only when the action icon is clicked.
You'll then need to declare a service worker by adding the following to your manifest:
"background": {
"service_worker": "worker.js"
}
And in worker.js, you can copy your code from popup.js making sure to use the action API instead of DOMContentLoaded.
How can you enable chrome extension on a specific web site? for an example
Activate or enable the chrome extension when you visit on a specific website say www.test.com
if the user browser through another than www.test.com then the icon should be deactivate or disable the chrome extension.
I have read about the pageAction and try to do the following:
manifest.js
{
"manifest_version": 2,
"name": "PageAction Sample",
"description": "PageAction Sample",
"version": "0.0.1",
"page_action": {
"default_icon": {
"32": "icon32.png"
}
},
"background": {
"scripts": [ "background.js" ],
"persistent": false
},
"permissions": [ "activeTab", "tabs" ]
}
background.js
chrome.tabs.onUpdated.addListener(function(tabId, changeInfo, tab) {
if (changeInfo.url) {
if (changeInfo.url == 'test.com)) {
chrome.pageAction.show(tabId);
} else {
chrome.pageAction.hide(tabId);
}
}
});
chrome.pageAction.onClicked.addListener(function(tab) {
chrome.tabs.executeScript(tab.id, {
file: "login.js"
});
});
popup.html
<!DOCTYPE html>
<html>
<head>
<title>Test Page</title>
</head>
<body>
<h3>Login Form</h3>
<form>
Username: <input id="username" type="text" name="username"> <br>
Password: <input id="password" type="password" name="password"> <br>
<input id="loginbutton" type="button" value="Login">
</form>
<script>
document.getElementById('loginbutton').onclick = function(event) {
var username = document.getElementById('username').value;
var password = document.getElementById('password').value;
setTimeout(function() {
alert('Username: ' + username + ' and Password: ' + password);
});
};
</script>
</body>
</html>
Show the UI (popup.html) page only the url is test.com
There are several problems here.
A bug in Chrome that always shows the extension's icon as active on all URLs.
You'll have to manually change the icon via chrome.pageAction.setIcon in onUpdated event. A more ergonomic/proper solution would be to use chrome.declarativeContent API (instead of onUpdated) with two actions: SetIcon and ShowPageAction (some demos).
Make a grayscale version of your main icon and specify it as the default icon in manifest.json, then use the above methods to set the normal icon on the matched site.
popup.html isn't specified anywhere. Add "default_popup": "popup.html" inside page_action section as shown in the documentation.
An inline <script> doesn't work in extensions by default so extract it to a separate popup.js file loaded as a standard tag like <script src=popup.js></script>.
chrome.pageAction.onClicked won't work with default_popup so move the contents of onClicked listener (executeScript block) into popup.js, right at the start of it or inside a click listener for some button.
Open the correct devtools console to observe the errors and output instead of using alert.
I'm trying to create a chrome extension, so I'm doing tutorials to learn and reading a bunch, but I'm struggling. I'm doing this tutorial. But long-term, from the extension I need users to be able to login to their account, then as they're browsing, send the url that they're at to their account.
popup.html
<!doctype html>
<html>
<head>
<title>Add a Snippet</title>
<script src="popup.js"></script>
<link rel="stylesheet" type="text/css" href="popup.css">
</head>
<body>
<h1>Add a Snippet</h1>
<form id="form">
<textarea id="code"></textarea>
<button type="submit" id="checkPage">Add Snippet</button>
</form>
</body>
</html>
popup.js
What I REALLY don't understand is that according to the console.log lines that I have in there and the error, it's loading the DOMContent, and it doesn't have any problem with finding the form by the id (let f = document.getElementById('form');). But it bombs when I try to attach an event listener?
document.addEventListener('DOMContentLoaded', function() {
console.log('the domcontentloaded');
let f = document.getElementById('form');
f.addEventListener('submit', function(e){
console.log('the form was submitted');
e.preventDefault();
})
}, false);
manifest.json
{
"name": "My Awesome Plugin",
"description": "This extension will be awesome",
"version": "1.0",
"browser_action": {
"default_icon": "icon.png",
"default_popup": "popup.html",
"default_title": "This is Awesome"
},
"background": {
"scripts": ["jquery-2.2.3.min.js", "background.js","popup.js"],
"persistent": false
},
"permissions": [
"activeTab",
"declarativeContent",
"https://ajax.googleapis.com/",
"storage",
"tabs",
"http://*/*",
"https://*/*"
],
"content_scripts": [
{
"matches": [
"<all_urls>"
],
"js": ["login.js"]
}
],
"manifest_version": 2
}
login.js
console.log('login.js is ready to party');
When I load, I get this in the background inspector (or whatever it's called). So it's not finding the form.
So I looked at the elements, and I'm confused because it's not showing the form or the textarea. But when I click on the chrome extension icon, it's there.
1/Remove popup.js from "background/scripts" section of your manifest.
2/Add popup.js as a script reference in your popup.html file.
This way, popup.js will operate in the context of the popup.html DOM.
When the chrome.tabs.create function is triggered by a message received, it creates 2 tabs. In the following demo code, 1 cat tab is created, and 2 dog tabs are created.
Is this by design or is it a bug? If it is a known bug, can you provide the bug id so I can track its progress? How can I avoid 2 duplicate tabs being created?
The debug console contains the following output, so in fact the duplicate tab is also getting the content script injected even though only one call to secondaryTabCreationCallback_ is printed in the debug output!!!!
Creating secondary tab
Created secondary tab: 11968
Kill request from tab: 11966
Kill request from tab: 11968
background.js
var handler = {
url1_: 'https://www.google.com/?gws_rd=ssl#q=cat',
url2_: 'https://www.google.com/?gws_rd=ssl#q=dog',
windowId_: chrome.windows.WINDOW_ID_CURRENT,
createPrimaryTab: function() {
chrome.tabs.create(
{'url': handler.url1_, 'active': false, 'windowId': handler.windowId_},
handler.primaryTabCreationCallback_);
},
primaryTabCreationCallback_: function(tab) {
chrome.tabs.executeScript(tab.id, {file: "content_script.js"});
},
createSecondaryTab_: function() {
console.log("Creating secondary tab");
chrome.tabs.create(
{'url': handler.url2_, 'active': false, 'windowId': handler.windowId_},
handler.secondaryTabCreationCallback_);
},
secondaryTabCreationCallback_: function(tab) {
console.log("Created secondary tab: " + tab.id);
chrome.tabs.executeScript(tab.id, {file: "content_script2.js"});
},
};
chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
switch (message.type) {
case "CREATE_TAB":
handler.createSecondaryTab_();
break;
case "KILL_ME":
console.log("Kill request from tab: " + sender.tab.id);
// chrome.tabs.remove(sender.tab.id);
break;
default:
alert("Not Reached");
break;
}
});
chrome.browserAction.onClicked.addListener(function(tab) {
chrome.tabs.create({'url': chrome.extension.getURL('background.html')});
});
window.onload = function() {
document.getElementById("start_button").onclick = handler.createPrimaryTab;
}
content_script.js
chrome.runtime.sendMessage({type: "CREATE_TAB"});
content_script2.js
chrome.runtime.sendMessage({type: "KILL_ME"});
background.html
<!doctype html>
<html>
<head>
<script src="background.js"></script>
</head>
<body>
<div>
<input type="button" id="start_button" value="Start">
</div>
</body>
</html>
manifest.json
{
"manifest_version": 2,
"name": "Tab Bug",
"description": "Demonstrates bug in chrome.tabs.create.",
"version": "1.0",
"permissions": [
"activeTab",
"nativeMessaging",
"tabs",
"https://www.google.com/"
],
"icons": { "128": "icon128.png" },
"browser_action": {
"default_icon": "icon19.png"
},
"background": {
"page": "background.html"
}
}
The issue is that there are 2 "background" pages running.
The official background page specified in the manifest file.
The tab created by chrome.tabs.create({'url':
chrome.extension.getURL('background.html')}).
This means there are 2 message listeners, which is why 2 tabs are opening.
The console messages from the official manifest.json background can be found by looking at extension on the chrome extensions page and click on the "Inspect views: background.html". Which shows:
Creating secondary tab
Created secondary tab: 11966
Kill request from tab: 11966
Kill request from tab: 11968
To work around this issue. The manifest.json background file can point to a script "starter.js" instead of an html page, which simply has the following javascript:
chrome.browserAction.onClicked.addListener(function(tab) {
chrome.tabs.create({'url': chrome.extension.getURL('background.html')});
});
My background.js is very simple.
chrome.browserAction.onClicked.addListener(() => {
chrome.tabs.create({
url: chrome.runtime.getURL('popup.html'),
})
})
manifest.json
"background": {
"persistent": false,
"scripts": [
"background.js"
]
},
Tried to disable/enable the extension (so that chrome destroys all the background pages from this extension) but it still opens duplicate tabs!!
So the problem might be there is someone that included the background.js. And guess what! It's popup.html.
The root cause is HtmlWebpackPlugin from webpack.config.js. It defaults to include all chunks (including background).
So we just exclude the background chunk from popup.html config then it should work as expected.
new HtmlWebpackPlugin({
template: 'public/popup.html',
filename: 'popup.html',
excludeChunks: ['background'],
}),
I'm trying to get a simple Google Chrome extension working where a message/variable flows through each of the following steps ...
DOM content (from specific HTML tag)
Contentscript.js
Background.js
Popup.js
Popup.html
I've figured out how to send a message/variable to Background.js and from it in one direction (Background.js -> Popup.js or Background.js -> Contentscript.js), but can't get it through all three successfully (Contentscript.js -> Background.js -> Popup.js). Here are the files in my demo.
Dom
<h1 class="name">Joe Blow</h1>
Content.js
fromDOM = $('h1.name').text();
chrome.runtime.sendMessage({contentscript: "from: contentscript.js", title: fromDOM}, function(b) {
console.log('on: contentscript.js === ' + b.background);
});
Background.js
chrome.tabs.getSelected(null, function(tab) {
chrome.extension.onMessage.addListener(function(msg, sender, sendResponse) {
sendResponse({background: "from: background.js"});
console.log('on: background.js === ' + msg.title);
});
});
Popup.js
chrome.extension.sendMessage({pop: "from: popup.js"}, function(b){
console.log('on: popup.js === ' + b.background);
$('.output').text(b.background);
});
Popup.html
<html>
<head>
<script src="jquery.js"></script>
<script src="popup.js"></script>
</head>
<body>
<p class="output"></p>
</body>
</html>
Manifest.json
{
"name": "Hello World",
"version": "1.0",
"manifest_version": 2,
"description": "My first Chrome extension.",
"background" : {
"scripts": ["background.js"]
},
"permissions": [
"tabs"
],
"browser_action": {
"default_icon": "icon.png",
"default_popup": "popup.html"
},
"content_scripts": [
{
"matches": ["http://*/*"],
"js": ["jquery.js","contentscript.js"],
"run_at": "document_end"
}
]
}
I have a feeling I know what the trip-up is, but the documentation is severely lacking for manifest_version: 2 that its tough to decipher. A simple, reusable example would be very helpful in the learning process, as I'm sure this is a common issue.
Alright, changing a few things in your code should make it work like you want. Not all of the changes I am going to make are necessary, but this is just how I might do it.
Content Script
var fromDOM = $('h1.name').text();
chrome.runtime.sendMessage({method:'setTitle',title:fromDOM});
Background
var title;
chrome.runtime.onMessage.addListener(function(message,sender,sendResponse){
if(message.method == 'setTitle')
title = message.title;
else if(message.method == 'getTitle')
sendResponse(title);
});
Popup.js
chrome.runtime.sendMessage({method:'getTitle'}, function(response){
$('.output').text(response);
});