Rozszerzenie Chrome - pobierz zawartość DOM

116

Próbuję uzyskać dostęp do zawartości activeTab DOM z mojego wyskakującego okienka. Oto mój manifest:

{
  "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"
  }
}

Jestem naprawdę zdezorientowany, czy skrypty działające w tle (strony zdarzeń z trwałością: false) lub content_scripts są drogą do zrobienia. Przeczytałem całą dokumentację i inne posty SO i nadal nie ma to dla mnie sensu.

Czy ktoś może wyjaśnić, dlaczego mógłbym użyć jednego nad drugim.

Oto plik background.js, który próbowałem:

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

I właśnie wykonuję to z wyskakującej konsoli:

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

Otrzymuję:

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

AKTUALIZACJA:

{
  "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);
  });
});

Po uruchomieniu nadal pojawia się ten sam błąd:

undefined
Port: Could not establish connection. Receiving end does not exist. lastError:30
undefined
brandonhilkert
źródło

Odpowiedzi:

184

Pojęcia „strona w tle”, „wyskakujące okienko”, „skrypt zawartości” nadal są dla Ciebie mylące; Zdecydowanie proponuję dokładniejsze zapoznanie się z dokumentacją rozszerzeń przeglądarki Google Chrome .

Jeśli chodzi o pytanie, czy skrypty zawartości lub strony działające w tle są do zrobienia:

Skrypty zawartości : zdecydowanie
skrypty zawartości to jedyny składnik rozszerzenia, który ma dostęp do DOM strony internetowej.

Strona w tle / wyskakujące okienko : Być może (prawdopodobnie maksymalnie 1 z dwóch)
Może być konieczne przekazanie przez skrypt zawartości treści DOM do strony w tle lub do wyskakującego okienka w celu dalszego przetwarzania.


Powtórzę, że zdecydowanie zalecam dokładniejsze przestudiowanie dostępnej dokumentacji!
To powiedziawszy, oto przykładowe rozszerzenie, które pobiera zawartość DOM ze stron StackOverflow i wysyła ją na stronę w tle, która z kolei drukuje ją w konsoli:

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
źródło
6
@solvingPuzzles: chrome.runtime.sendMessagewysyła wiadomości do BackgroundPage i do Popups. chrome.tabs.sendMessagewysyła wiadomości do ContentScripts.
gkalpak
23
Negocjowano, ponieważ ta odpowiedź nie wyjaśnia, jak uzyskać RZECZYWISTY DOM z bieżącej karty.
John Paul Barbagallo
2
@JohnPaulBarbagallo: Pytanie dotyczyło zdobycia zawartości DOM, a nie dostępu / manipulowania rzeczywistym DOM. Myślę, że moja odpowiedź to robi (a inni wydają się myśleć w ten sam sposób). Jeśli masz lepsze rozwiązanie, zamieść je jako odpowiedź. Jeśli masz inne wymagania, opublikuj je jako nowe pytanie. W każdym razie
dziękuję
2
@zoltar: Jest drukowane w konsoli tła strony.
gkalpak
2
Mam skopiuj / paster tę odpowiedź, ale nie mogę uzyskać żadnego pliku console.log ze skryptu zawartości. prosimy o pomoc!
ClementWalter
72

Nie musisz używać przekazywania wiadomości, aby uzyskać lub zmodyfikować DOM. chrome.tabs.executeScriptZamiast tego użyłem . W moim przykładzie używam tylko uprawnienia activeTab, dlatego skrypt jest wykonywany tylko na aktywnej karcie.

część 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
źródło
1
Działa świetnie! Dziękuję Ci. Nie wiem dlaczego, ale nie mogłem sprawić, by przyjęte rozwiązanie zadziałało dla mnie.
goodfellow
Twoje oświadczenie, że używasz wyłącznie activeTabpozwolenia, jest niedokładne. Wyraźnie uzyskujesz <all_urls>oprócz activeTab.
Makyen
1
test.js to skrypt, który umieściłeś w kodzie HTML swojej strony, więc nie jestem pewien, czy potrzebujesz żadnych uprawnień.
Scott Baker
11

Dla tych, którzy wypróbowali odpowiedź gkalpak i nie zadziałała,

pamiętaj, że chrome doda skrypt zawartości do potrzebnej strony tylko wtedy, gdy twoje rozszerzenie jest włączone podczas uruchamiania chrome, a także dobrym pomysłem jest ponowne uruchomienie przeglądarki po wprowadzeniu tych zmian

bxN5
źródło
1
To uratowało mi dzień
Romain Derie