Merge pull request #5711 from electron/extension-code-cleanup
Implement partial chrome.* API for devtools extension
This commit is contained in:
commit
9f0fc96025
32 changed files with 1151 additions and 216 deletions
|
@ -71,12 +71,15 @@ let wrapWebContents = function (webContents) {
|
|||
webContents.setMaxListeners(0)
|
||||
|
||||
// WebContents::send(channel, args..)
|
||||
webContents.send = function (channel, ...args) {
|
||||
// WebContents::sendToAll(channel, args..)
|
||||
const sendWrapper = (allFrames, channel, ...args) => {
|
||||
if (channel == null) {
|
||||
throw new Error('Missing required channel argument')
|
||||
}
|
||||
return this._send(channel, args)
|
||||
return webContents._send(allFrames, channel, args)
|
||||
}
|
||||
webContents.send = sendWrapper.bind(null, false)
|
||||
webContents.sendToAll = sendWrapper.bind(null, true)
|
||||
|
||||
// The navigation controller.
|
||||
controller = new NavigationController(webContents)
|
||||
|
@ -218,9 +221,12 @@ binding._setWrapWebContents(wrapWebContents)
|
|||
debuggerBinding._setWrapDebugger(wrapDebugger)
|
||||
sessionBinding._setWrapSession(wrapSession)
|
||||
|
||||
module.exports.create = function (options) {
|
||||
if (options == null) {
|
||||
options = {}
|
||||
module.exports = {
|
||||
create (options = {}) {
|
||||
return binding.create(options)
|
||||
},
|
||||
|
||||
fromId (id) {
|
||||
return binding.fromId(id)
|
||||
}
|
||||
return binding.create(options)
|
||||
}
|
||||
|
|
|
@ -1,56 +1,224 @@
|
|||
const {app, protocol, BrowserWindow} = require('electron')
|
||||
const {app, ipcMain, protocol, webContents, BrowserWindow} = require('electron')
|
||||
const renderProcessPreferences = process.atomBinding('render_process_preferences').forAllBrowserWindow()
|
||||
|
||||
const fs = require('fs')
|
||||
const path = require('path')
|
||||
const url = require('url')
|
||||
|
||||
// Mapping between hostname and file path.
|
||||
var hostPathMap = {}
|
||||
var hostPathMapNextKey = 0
|
||||
|
||||
var getHostForPath = function (path) {
|
||||
var key
|
||||
key = 'extension-' + (++hostPathMapNextKey)
|
||||
hostPathMap[key] = path
|
||||
return key
|
||||
// TODO(zcbenz): Remove this when we have Object.values().
|
||||
const objectValues = function (object) {
|
||||
return Object.keys(object).map(function (key) { return object[key] })
|
||||
}
|
||||
|
||||
var getPathForHost = function (host) {
|
||||
return hostPathMap[host]
|
||||
// Mapping between extensionId(hostname) and manifest.
|
||||
const manifestMap = {} // extensionId => manifest
|
||||
const manifestNameMap = {} // name => manifest
|
||||
|
||||
const generateExtensionIdFromName = function (name) {
|
||||
return name.replace(/[\W_]+/g, '-').toLowerCase()
|
||||
}
|
||||
|
||||
// Cache extensionInfo.
|
||||
var extensionInfoMap = {}
|
||||
|
||||
var getExtensionInfoFromPath = function (srcDirectory) {
|
||||
var manifest, page
|
||||
manifest = JSON.parse(fs.readFileSync(path.join(srcDirectory, 'manifest.json')))
|
||||
if (extensionInfoMap[manifest.name] == null) {
|
||||
// We can not use 'file://' directly because all resources in the extension
|
||||
// will be treated as relative to the root in Chrome.
|
||||
page = url.format({
|
||||
protocol: 'chrome-extension',
|
||||
slashes: true,
|
||||
hostname: getHostForPath(srcDirectory),
|
||||
pathname: manifest.devtools_page
|
||||
})
|
||||
extensionInfoMap[manifest.name] = {
|
||||
startPage: page,
|
||||
name: manifest.name,
|
||||
// Create or get manifest object from |srcDirectory|.
|
||||
const getManifestFromPath = function (srcDirectory) {
|
||||
const manifest = JSON.parse(fs.readFileSync(path.join(srcDirectory, 'manifest.json')))
|
||||
if (!manifestNameMap[manifest.name]) {
|
||||
const extensionId = generateExtensionIdFromName(manifest.name)
|
||||
console.log(extensionId)
|
||||
manifestMap[extensionId] = manifestNameMap[manifest.name] = manifest
|
||||
Object.assign(manifest, {
|
||||
srcDirectory: srcDirectory,
|
||||
exposeExperimentalAPIs: true
|
||||
}
|
||||
return extensionInfoMap[manifest.name]
|
||||
extensionId: extensionId,
|
||||
// We can not use 'file://' directly because all resources in the extension
|
||||
// will be treated as relative to the root in Chrome.
|
||||
startPage: url.format({
|
||||
protocol: 'chrome-extension',
|
||||
slashes: true,
|
||||
hostname: extensionId,
|
||||
pathname: manifest.devtools_page
|
||||
})
|
||||
})
|
||||
return manifest
|
||||
}
|
||||
}
|
||||
|
||||
// The loaded extensions cache and its persistent path.
|
||||
var loadedExtensions = null
|
||||
var loadedExtensionsPath = null
|
||||
// Manage the background pages.
|
||||
const backgroundPages = {}
|
||||
|
||||
const startBackgroundPages = function (manifest) {
|
||||
if (backgroundPages[manifest.extensionId] || !manifest.background) return
|
||||
|
||||
const scripts = manifest.background.scripts.map((name) => {
|
||||
return `<script src="${name}"></script>`
|
||||
}).join('')
|
||||
const html = new Buffer(`<html><body>${scripts}</body></html>`)
|
||||
|
||||
const contents = webContents.create({
|
||||
commandLineSwitches: ['--background-page']
|
||||
})
|
||||
backgroundPages[manifest.extensionId] = { html: html, webContents: contents }
|
||||
contents.loadURL(url.format({
|
||||
protocol: 'chrome-extension',
|
||||
slashes: true,
|
||||
hostname: manifest.extensionId,
|
||||
pathname: '_generated_background_page.html'
|
||||
}))
|
||||
}
|
||||
|
||||
const removeBackgroundPages = function (manifest) {
|
||||
if (!backgroundPages[manifest.extensionId]) return
|
||||
|
||||
backgroundPages[manifest.extensionId].webContents.destroy()
|
||||
delete backgroundPages[manifest.extensionId]
|
||||
}
|
||||
|
||||
// Dispatch tabs events.
|
||||
const hookWindowForTabEvents = function (win) {
|
||||
const tabId = win.webContents.id
|
||||
for (const page of objectValues(backgroundPages)) {
|
||||
page.webContents.sendToAll('CHROME_TABS_ONCREATED', tabId)
|
||||
}
|
||||
|
||||
win.once('closed', () => {
|
||||
for (const page of objectValues(backgroundPages)) {
|
||||
page.webContents.sendToAll('CHROME_TABS_ONREMOVED', tabId)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// Handle the chrome.* API messages.
|
||||
let nextId = 0
|
||||
|
||||
ipcMain.on('CHROME_RUNTIME_CONNECT', function (event, extensionId, connectInfo) {
|
||||
const page = backgroundPages[extensionId]
|
||||
if (!page) {
|
||||
console.error(`Connect to unkown extension ${extensionId}`)
|
||||
return
|
||||
}
|
||||
|
||||
const portId = ++nextId
|
||||
event.returnValue = {tabId: page.webContents.id, portId: portId}
|
||||
|
||||
event.sender.once('render-view-deleted', () => {
|
||||
if (page.webContents.isDestroyed()) return
|
||||
page.webContents.sendToAll(`CHROME_PORT_DISCONNECT_${portId}`)
|
||||
})
|
||||
page.webContents.sendToAll(`CHROME_RUNTIME_ONCONNECT_${extensionId}`, event.sender.id, portId, connectInfo)
|
||||
})
|
||||
|
||||
ipcMain.on('CHROME_RUNTIME_SENDMESSAGE', function (event, extensionId, message) {
|
||||
const page = backgroundPages[extensionId]
|
||||
if (!page) {
|
||||
console.error(`Connect to unkown extension ${extensionId}`)
|
||||
return
|
||||
}
|
||||
|
||||
page.webContents.sendToAll(`CHROME_RUNTIME_ONMESSAGE_${extensionId}`, event.sender.id, message)
|
||||
})
|
||||
|
||||
ipcMain.on('CHROME_TABS_SEND_MESSAGE', function (event, tabId, extensionId, isBackgroundPage, message) {
|
||||
const contents = webContents.fromId(tabId)
|
||||
if (!contents) {
|
||||
console.error(`Sending message to unkown tab ${tabId}`)
|
||||
return
|
||||
}
|
||||
|
||||
const senderTabId = isBackgroundPage ? null : event.sender.id
|
||||
|
||||
contents.sendToAll(`CHROME_RUNTIME_ONMESSAGE_${extensionId}`, senderTabId, message)
|
||||
})
|
||||
|
||||
ipcMain.on('CHROME_TABS_EXECUTESCRIPT', function (event, requestId, tabId, extensionId, details) {
|
||||
const contents = webContents.fromId(tabId)
|
||||
if (!contents) {
|
||||
console.error(`Sending message to unkown tab ${tabId}`)
|
||||
return
|
||||
}
|
||||
|
||||
let code, url
|
||||
if (details.file) {
|
||||
const manifest = manifestMap[extensionId]
|
||||
code = String(fs.readFileSync(path.join(manifest.srcDirectory, details.file)))
|
||||
url = `chrome-extension://${extensionId}${details.file}`
|
||||
} else {
|
||||
code = details.code
|
||||
url = `chrome-extension://${extensionId}/${String(Math.random()).substr(2, 8)}.js`
|
||||
}
|
||||
|
||||
contents.send('CHROME_TABS_EXECUTESCRIPT', event.sender.id, requestId, extensionId, url, code)
|
||||
})
|
||||
|
||||
// Transfer the content scripts to renderer.
|
||||
const contentScripts = {}
|
||||
|
||||
const injectContentScripts = function (manifest) {
|
||||
if (contentScripts[manifest.name] || !manifest.content_scripts) return
|
||||
|
||||
const readArrayOfFiles = function (relativePath) {
|
||||
return {
|
||||
url: `chrome-extension://${manifest.extensionId}/${relativePath}`,
|
||||
code: String(fs.readFileSync(path.join(manifest.srcDirectory, relativePath)))
|
||||
}
|
||||
}
|
||||
|
||||
const contentScriptToEntry = function (script) {
|
||||
return {
|
||||
matches: script.matches,
|
||||
js: script.js.map(readArrayOfFiles),
|
||||
runAt: script.run_at || 'document_idle'
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const entry = {
|
||||
extensionId: manifest.extensionId,
|
||||
contentScripts: manifest.content_scripts.map(contentScriptToEntry)
|
||||
}
|
||||
contentScripts[manifest.name] = renderProcessPreferences.addEntry(entry)
|
||||
} catch (e) {
|
||||
console.error('Failed to read content scripts', e)
|
||||
}
|
||||
}
|
||||
|
||||
const removeContentScripts = function (manifest) {
|
||||
if (!contentScripts[manifest.name]) return
|
||||
|
||||
renderProcessPreferences.removeEntry(contentScripts[manifest.name])
|
||||
delete contentScripts[manifest.name]
|
||||
}
|
||||
|
||||
// Transfer the |manifest| to a format that can be recognized by the
|
||||
// |DevToolsAPI.addExtensions|.
|
||||
const manifestToExtensionInfo = function (manifest) {
|
||||
return {
|
||||
startPage: manifest.startPage,
|
||||
srcDirectory: manifest.srcDirectory,
|
||||
name: manifest.name,
|
||||
exposeExperimentalAPIs: true
|
||||
}
|
||||
}
|
||||
|
||||
// Load the extensions for the window.
|
||||
const loadExtension = function (manifest) {
|
||||
startBackgroundPages(manifest)
|
||||
injectContentScripts(manifest)
|
||||
}
|
||||
|
||||
const loadDevToolsExtensions = function (win, manifests) {
|
||||
if (!win.devToolsWebContents) return
|
||||
|
||||
manifests.forEach(loadExtension)
|
||||
|
||||
const extensionInfoArray = manifests.map(manifestToExtensionInfo)
|
||||
win.devToolsWebContents.executeJavaScript(`DevToolsAPI.addExtensions(${JSON.stringify(extensionInfoArray)})`)
|
||||
}
|
||||
|
||||
// The persistent path of "DevTools Extensions" preference file.
|
||||
let loadedExtensionsPath = null
|
||||
|
||||
app.on('will-quit', function () {
|
||||
try {
|
||||
loadedExtensions = Object.keys(extensionInfoMap).map(function (key) {
|
||||
return extensionInfoMap[key].srcDirectory
|
||||
const loadedExtensions = objectValues(manifestMap).map(function (manifest) {
|
||||
return manifest.srcDirectory
|
||||
})
|
||||
if (loadedExtensions.length > 0) {
|
||||
try {
|
||||
|
@ -69,74 +237,78 @@ app.on('will-quit', function () {
|
|||
|
||||
// We can not use protocol or BrowserWindow until app is ready.
|
||||
app.once('ready', function () {
|
||||
var chromeExtensionHandler, i, init, len, srcDirectory
|
||||
// The chrome-extension: can map a extension URL request to real file path.
|
||||
const chromeExtensionHandler = function (request, callback) {
|
||||
const parsed = url.parse(request.url)
|
||||
if (!parsed.hostname || !parsed.path) return callback()
|
||||
|
||||
const manifest = manifestMap[parsed.hostname]
|
||||
if (!manifest) return callback()
|
||||
|
||||
if (parsed.path === '/_generated_background_page.html' &&
|
||||
backgroundPages[parsed.hostname]) {
|
||||
return callback({
|
||||
mimeType: 'text/html',
|
||||
data: backgroundPages[parsed.hostname].html
|
||||
})
|
||||
}
|
||||
|
||||
fs.readFile(path.join(manifest.srcDirectory, parsed.path), function (err, content) {
|
||||
if (err) {
|
||||
return callback(-6) // FILE_NOT_FOUND
|
||||
} else {
|
||||
return callback(content)
|
||||
}
|
||||
})
|
||||
}
|
||||
protocol.registerBufferProtocol('chrome-extension', chromeExtensionHandler, function (error) {
|
||||
if (error) {
|
||||
console.error(`Unable to register chrome-extension protocol: ${error}`)
|
||||
}
|
||||
})
|
||||
|
||||
// Load persisted extensions.
|
||||
loadedExtensionsPath = path.join(app.getPath('userData'), 'DevTools Extensions')
|
||||
try {
|
||||
loadedExtensions = JSON.parse(fs.readFileSync(loadedExtensionsPath))
|
||||
if (!Array.isArray(loadedExtensions)) {
|
||||
loadedExtensions = []
|
||||
}
|
||||
|
||||
// Preheat the extensionInfo cache.
|
||||
for (i = 0, len = loadedExtensions.length; i < len; i++) {
|
||||
srcDirectory = loadedExtensions[i]
|
||||
getExtensionInfoFromPath(srcDirectory)
|
||||
const loadedExtensions = JSON.parse(fs.readFileSync(loadedExtensionsPath))
|
||||
if (Array.isArray(loadedExtensions)) {
|
||||
for (const srcDirectory of loadedExtensions) {
|
||||
// Start background pages and set content scripts.
|
||||
const manifest = getManifestFromPath(srcDirectory)
|
||||
loadExtension(manifest)
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
// Ignore error
|
||||
}
|
||||
|
||||
// The chrome-extension: can map a extension URL request to real file path.
|
||||
chromeExtensionHandler = function (request, callback) {
|
||||
var directory, parsed
|
||||
parsed = url.parse(request.url)
|
||||
if (!(parsed.hostname && (parsed.path != null))) {
|
||||
return callback()
|
||||
}
|
||||
if (!/extension-\d+/.test(parsed.hostname)) {
|
||||
return callback()
|
||||
}
|
||||
directory = getPathForHost(parsed.hostname)
|
||||
if (directory == null) {
|
||||
return callback()
|
||||
}
|
||||
return callback(path.join(directory, parsed.path))
|
||||
}
|
||||
protocol.registerFileProtocol('chrome-extension', chromeExtensionHandler, function (error) {
|
||||
if (error) {
|
||||
return console.error('Unable to register chrome-extension protocol')
|
||||
}
|
||||
})
|
||||
BrowserWindow.prototype._loadDevToolsExtensions = function (extensionInfoArray) {
|
||||
var ref
|
||||
return (ref = this.devToolsWebContents) != null ? ref.executeJavaScript('DevToolsAPI.addExtensions(' + (JSON.stringify(extensionInfoArray)) + ');') : void 0
|
||||
}
|
||||
// The public API to add/remove extensions.
|
||||
BrowserWindow.addDevToolsExtension = function (srcDirectory) {
|
||||
var extensionInfo, j, len1, ref, window
|
||||
extensionInfo = getExtensionInfoFromPath(srcDirectory)
|
||||
if (extensionInfo) {
|
||||
ref = BrowserWindow.getAllWindows()
|
||||
for (j = 0, len1 = ref.length; j < len1; j++) {
|
||||
window = ref[j]
|
||||
window._loadDevToolsExtensions([extensionInfo])
|
||||
const manifest = getManifestFromPath(srcDirectory)
|
||||
if (manifest) {
|
||||
for (const win of BrowserWindow.getAllWindows()) {
|
||||
loadDevToolsExtensions(win, [manifest])
|
||||
}
|
||||
return extensionInfo.name
|
||||
return manifest.name
|
||||
}
|
||||
}
|
||||
BrowserWindow.removeDevToolsExtension = function (name) {
|
||||
return delete extensionInfoMap[name]
|
||||
const manifest = manifestNameMap[name]
|
||||
if (!manifest) return
|
||||
|
||||
removeBackgroundPages(manifest)
|
||||
removeContentScripts(manifest)
|
||||
delete manifestMap[manifest.extensionId]
|
||||
delete manifestNameMap[name]
|
||||
}
|
||||
|
||||
// Load persisted extensions when devtools is opened.
|
||||
init = BrowserWindow.prototype._init
|
||||
// Load extensions automatically when devtools is opened.
|
||||
const init = BrowserWindow.prototype._init
|
||||
BrowserWindow.prototype._init = function () {
|
||||
init.call(this)
|
||||
return this.webContents.on('devtools-opened', () => {
|
||||
return this._loadDevToolsExtensions(Object.keys(extensionInfoMap).map(function (key) {
|
||||
return extensionInfoMap[key]
|
||||
}))
|
||||
hookWindowForTabEvents(this)
|
||||
this.webContents.on('devtools-opened', () => {
|
||||
loadDevToolsExtensions(this, objectValues(manifestMap))
|
||||
})
|
||||
}
|
||||
})
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
const electron = require('electron')
|
||||
const v8Util = process.atomBinding('v8_util')
|
||||
const {ipcMain, isPromise} = electron
|
||||
const {ipcMain, isPromise, webContents} = electron
|
||||
|
||||
const objectsRegistry = require('./objects-registry')
|
||||
|
||||
|
@ -353,3 +353,17 @@ ipcMain.on('ELECTRON_BROWSER_ASYNC_CALL_TO_GUEST_VIEW', function (event, request
|
|||
event.returnValue = exceptionToMeta(error)
|
||||
}
|
||||
})
|
||||
|
||||
ipcMain.on('ELECTRON_BROWSER_SEND_TO', function (event, sendToAll, webContentsId, channel, ...args) {
|
||||
let contents = webContents.fromId(webContentsId)
|
||||
if (!contents) {
|
||||
console.error(`Sending message to WebContents with unknown ID ${webContentsId}`)
|
||||
return
|
||||
}
|
||||
|
||||
if (sendToAll) {
|
||||
contents.sendToAll(channel, ...args)
|
||||
} else {
|
||||
contents.send(channel, ...args)
|
||||
}
|
||||
})
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue