Extensão do Chrome - obter conteúdo DOM

116

Estou tentando acessar o conteúdo ActiveTab DOM do meu pop-up. Aqui está meu manifesto:

{
  "manifest_version": 2,

  "name": "Test",
  "description": "Test script",
  "version": "0.1",

  "permissions": [
    "activeTab",
    "https://api.domain.com/"
  ],

  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'",

  "browser_action": {
    "default_icon": "icon.png",
    "default_title": "Chrome Extension test",
    "default_popup": "index.html"
  }
}

Estou realmente confuso se scripts de fundo (páginas de eventos com persistência: false) ou content_scripts são o caminho a percorrer. Eu li toda a documentação e outros posts do SO e ainda não faz sentido para mim.

Alguém pode explicar por que devo usar um em vez do outro.

Aqui está o background.js que estou testando:

chrome.extension.onMessage.addListener(
  function(request, sender, sendResponse) {
    // LOG THE CONTENTS HERE
    console.log(request.content);
  }
);

E estou apenas executando isso no console pop-up:

chrome.tabs.getSelected(null, function(tab) {
  chrome.tabs.sendMessage(tab.id, { }, function(response) {
    console.log(response);
  });
});

Estou entendendo:

Port: Could not establish connection. Receiving end does not exist. 

ATUALIZAR:

{
  "manifest_version": 2,

  "name": "test",
  "description": "test",
  "version": "0.1",

  "permissions": [
    "tabs",
    "activeTab",
    "https://api.domain.com/"
  ],

  "content_scripts": [
    {
      "matches": ["<all_urls>"],
      "js": ["content.js"]
    }
  ],

  "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'",

  "browser_action": {
    "default_icon": "icon.png",
    "default_title": "Test",
    "default_popup": "index.html"
  }
}

content.js

chrome.extension.onMessage.addListener(
  function(request, sender, sendResponse) {
    if (request.text && (request.text == "getDOM")) {
      sendResponse({ dom: document.body.innerHTML });
    }
  }
);

popup.html

chrome.tabs.getSelected(null, function(tab) {
  chrome.tabs.sendMessage(tab.id, { action: "getDOM" }, function(response) {
    console.log(response);
  });
});

Quando o executo, ainda recebo o mesmo erro:

undefined
Port: Could not establish connection. Receiving end does not exist. lastError:30
undefined
Brandonhilkert
fonte

Respostas:

184

Os termos "página de fundo", "pop-up", "script de conteúdo" ainda estão confundindo você; Eu sugiro fortemente uma análise mais aprofundada da Documentação das Extensões do Google Chrome .

Em relação à sua pergunta se scripts de conteúdo ou páginas de fundo são o caminho a percorrer:

Scripts de conteúdo : definitivamente os
scripts de conteúdo são o único componente de uma extensão que tem acesso ao DOM da página da web.

Página /
pop-up de fundo : talvez (provavelmente no máximo 1 dos dois) Você pode precisar que o script de conteúdo passe o conteúdo DOM para uma página de fundo ou para o pop-up para processamento posterior.


Deixe-me repetir que recomendo fortemente um estudo mais cuidadoso da documentação disponível!
Dito isso, aqui está um exemplo de extensão que recupera o conteúdo DOM nas páginas StackOverflow e o envia para a página de fundo, que por sua vez o imprime no console:

background.js:

// Regex-pattern to check URLs against. 
// It matches URLs like: http[s]://[...]stackoverflow.com[...]
var urlRegex = /^https?:\/\/(?:[^./?#]+\.)?stackoverflow\.com/;

// A function to use as callback
function doStuffWithDom(domContent) {
    console.log('I received the following DOM content:\n' + domContent);
}

// When the browser-action button is clicked...
chrome.browserAction.onClicked.addListener(function (tab) {
    // ...check the URL of the active tab against our pattern and...
    if (urlRegex.test(tab.url)) {
        // ...if it matches, send a message specifying a callback too
        chrome.tabs.sendMessage(tab.id, {text: 'report_back'}, doStuffWithDom);
    }
});

content.js:

// Listen for messages
chrome.runtime.onMessage.addListener(function (msg, sender, sendResponse) {
    // If the received message has the expected format...
    if (msg.text === 'report_back') {
        // Call the specified callback, passing
        // the web-page's DOM content as argument
        sendResponse(document.all[0].outerHTML);
    }
});

manifest.json:

{
  "manifest_version": 2,
  "name": "Test Extension",
  "version": "0.0",
  ...

  "background": {
    "persistent": false,
    "scripts": ["background.js"]
  },
  "content_scripts": [{
    "matches": ["*://*.stackoverflow.com/*"],
    "js": ["content.js"]
  }],
  "browser_action": {
    "default_title": "Test Extension"
  },

  "permissions": ["activeTab"]
}
gkalpak
fonte
6
@solvingPuzzles: chrome.runtime.sendMessageenvia mensagens para a BackgroundPage e para Popups. chrome.tabs.sendMessageenvia mensagens para ContentScripts.
gkalpak
23
Não votado porque esta resposta não explica como obter o DOM ACTUAL da guia atual.
John Paul Barbagallo
2
@JohnPaulBarbagallo: A questão era sobre como obter o conteúdo DOM, não sobre acessar / manipular o DOM real. Acho que minha resposta faz isso (e outros parecem pensar da mesma forma). Se você tiver uma solução melhor, poste-a como uma resposta. Se você tiver um requisito diferente, coloque-o como uma nova pergunta. Em qualquer caso, obrigado pelo feedback :)
gkalpak
2
@zoltar: é impresso no console da página de fundo.
gkalpak
2
Copiei / colei esta resposta, mas não consigo obter nenhum console.log do script de conteúdo. ajuda por favor!
ClementWalter
72

Você não precisa usar a passagem de mensagens para obter ou modificar o DOM. Eu usei em seu chrome.tabs.executeScriptlugar. No meu exemplo, estou usando apenas a permissão activeTab, portanto, o script é executado apenas na guia ativa.

parte de manifest.json

"browser_action": {
    "default_title": "Test",
    "default_popup": "index.html"
},
"permissions": [
    "activeTab",
    "<all_urls>"
]

index.html

<!DOCTYPE html>
<html>
  <head></head>
  <body>
    <button id="test">TEST!</button>
    <script src="test.js"></script>
  </body>
</html>

test.js

document.getElementById("test").addEventListener('click', () => {
    console.log("Popup DOM fully loaded and parsed");

    function modifyDOM() {
        //You can play with your DOM here or check URL against your regex
        console.log('Tab script:');
        console.log(document.body);
        return document.body.innerHTML;
    }

    //We have permission to access the activeTab, so we can call chrome.tabs.executeScript:
    chrome.tabs.executeScript({
        code: '(' + modifyDOM + ')();' //argument here is a string but function.toString() returns function's code
    }, (results) => {
        //Here we have just the innerHTML and not DOM structure
        console.log('Popup script:')
        console.log(results[0]);
    });
});
Oskar
fonte
1
Funciona perfeitamente! Obrigado. Não sei por que, mas não consegui fazer a solução aceita funcionar para mim.
goodfellow de
Sua declaração de que você está usando apenas activeTabpermissão é imprecisa. Você está claramente obtendo <all_urls>além de activeTab.
Makyen
1
test.js é um script que você incluiu no HTML da sua página, então não tenho certeza se você precisa de qualquer permissão.
Scott Baker
11

Para aqueles que tentaram a resposta gkalpak e não funcionou,

Esteja ciente de que o Chrome adicionará o script de conteúdo a uma página necessária apenas quando sua extensão for habilitada durante a inicialização do Chrome e também é uma boa ideia reiniciar o navegador após fazer essas alterações

bxN5
fonte
1
Isso salvou meu dia
Romain Derie