cd05834d96
This change gives sandboxed renderer scripts a similar structure to what already
exists in the lib/{browser,renderer,common} directories.
It also allows sandboxed renderer initialization to share more code with
non-sandboxed renderers (ipcRenderer is now imported directly from
lib/renderer/api/ipc-renderer).
75 lines
2.9 KiB
JavaScript
75 lines
2.9 KiB
JavaScript
// Any requires added here need to be added to the browserify_entries array
|
|
// in filenames.gypi so they get built into the preload_bundle.js bundle
|
|
|
|
/* eslint no-eval: "off" */
|
|
/* global binding, preloadPath, Buffer */
|
|
const events = require('events')
|
|
|
|
process.atomBinding = require('../common/atom-binding-setup')(binding.get, 'renderer')
|
|
|
|
const v8Util = process.atomBinding('v8_util')
|
|
// The `lib/renderer/api/ipc-renderer.js` module looks for the ipc object in the
|
|
// "ipc" hidden value
|
|
v8Util.setHiddenValue(global, 'ipc', new events.EventEmitter())
|
|
// The process object created by browserify is not an event emitter, fix it so
|
|
// the API is more compatible with non-sandboxed renderers.
|
|
for (let prop of Object.keys(events.EventEmitter.prototype)) {
|
|
if (process.hasOwnProperty(prop)) {
|
|
delete process[prop]
|
|
}
|
|
}
|
|
Object.setPrototypeOf(process, events.EventEmitter.prototype)
|
|
|
|
const electron = require('electron')
|
|
const preloadModules = new Map([
|
|
['electron', electron]
|
|
])
|
|
|
|
// Fetch the preload script. This needs to be done through the browser process
|
|
// since we may not have filesystem access in a sandboxed renderer.
|
|
let preloadSrc = electron.ipcRenderer.sendSync('ELECTRON_BROWSER_READ_FILE', preloadPath)
|
|
if (preloadSrc.err) {
|
|
throw new Error(preloadSrc.err)
|
|
}
|
|
|
|
// Pass different process object to the preload script(which should not have
|
|
// access to things like `process.atomBinding`).
|
|
const preloadProcess = new events.EventEmitter()
|
|
process.on('exit', () => preloadProcess.emit('exit'))
|
|
|
|
// This is the `require` function that will be visible to the preload script
|
|
function preloadRequire (module) {
|
|
if (preloadModules.has(module)) {
|
|
return preloadModules.get(module)
|
|
}
|
|
throw new Error('module not found')
|
|
}
|
|
|
|
// Wrap the script into a function executed in global scope. It won't have
|
|
// access to the current scope, so we'll expose a few objects as arguments:
|
|
//
|
|
// - `require`: The `preloadRequire` function
|
|
// - `process`: The `preloadProcess` object
|
|
// - `Buffer`: Browserify `Buffer` implementation
|
|
// - `global`: The window object, which is aliased to `global` by browserify.
|
|
//
|
|
// Browserify bundles can make use of an external require function as explained
|
|
// in https://github.com/substack/node-browserify#multiple-bundles, so electron
|
|
// apps can use multi-module preload scripts in sandboxed renderers.
|
|
//
|
|
// For example, the user can create a bundle with:
|
|
//
|
|
// $ browserify -x electron preload.js > renderer.js
|
|
//
|
|
// and any `require('electron')` calls in `preload.js` will work as expected
|
|
// since browserify won't try to include `electron` in the bundle, falling back
|
|
// to the `preloadRequire` function above.
|
|
let preloadWrapperSrc = `(function(require, process, Buffer, global) {
|
|
${preloadSrc.data}
|
|
})`
|
|
|
|
// eval in window scope:
|
|
// http://www.ecma-international.org/ecma-262/5.1/#sec-10.4.2
|
|
const geval = eval
|
|
let preloadFn = geval(preloadWrapperSrc)
|
|
preloadFn(preloadRequire, preloadProcess, Buffer, global)
|