electron/lib/browser/api/web-contents.js

287 lines
8.2 KiB
JavaScript
Raw Normal View History

'use strict'
2016-01-13 03:55:49 +00:00
const {EventEmitter} = require('events')
const electron = require('electron')
const {app, ipcMain, session, NavigationController} = electron
// session is not used here, the purpose is to make sure session is initalized
// before the webContents module.
session
2016-01-12 02:40:23 +00:00
let nextId = 0
const getNextId = function () {
return ++nextId
}
2016-01-12 02:40:23 +00:00
2016-06-01 06:24:53 +00:00
// Stock page sizes
const PDFPageSizes = {
2016-01-12 02:40:23 +00:00
A5: {
custom_display_name: 'A5',
2016-01-12 02:40:23 +00:00
height_microns: 210000,
name: 'ISO_A5',
2016-01-12 02:40:23 +00:00
width_microns: 148000
},
A4: {
custom_display_name: 'A4',
2016-01-12 02:40:23 +00:00
height_microns: 297000,
name: 'ISO_A4',
is_default: 'true',
2016-01-12 02:40:23 +00:00
width_microns: 210000
},
A3: {
custom_display_name: 'A3',
2016-01-12 02:40:23 +00:00
height_microns: 420000,
name: 'ISO_A3',
2016-01-12 02:40:23 +00:00
width_microns: 297000
},
Legal: {
custom_display_name: 'Legal',
2016-01-12 02:40:23 +00:00
height_microns: 355600,
name: 'NA_LEGAL',
2016-01-12 02:40:23 +00:00
width_microns: 215900
},
Letter: {
custom_display_name: 'Letter',
2016-01-12 02:40:23 +00:00
height_microns: 279400,
name: 'NA_LETTER',
2016-01-12 02:40:23 +00:00
width_microns: 215900
},
Tabloid: {
height_microns: 431800,
name: 'NA_LEDGER',
2016-01-12 02:40:23 +00:00
width_microns: 279400,
custom_display_name: 'Tabloid'
2016-01-12 02:40:23 +00:00
}
}
2016-01-12 02:40:23 +00:00
2016-06-01 06:24:53 +00:00
// Default printing setting
const defaultPrintingSetting = {
pageRage: [],
mediaSize: {},
landscape: false,
color: 2,
headerFooterEnabled: false,
marginsType: 0,
isFirstRequest: false,
requestID: getNextId(),
previewModifiable: true,
printToPDF: true,
printWithCloudPrint: false,
printWithPrivet: false,
printWithExtension: false,
deviceName: 'Save as PDF',
generateDraftData: true,
fitToPageEnabled: false,
duplex: 0,
copies: 1,
collate: true,
shouldPrintBackgrounds: false,
shouldPrintSelectionOnly: false
}
// JavaScript implementations of WebContents.
2016-08-02 11:38:35 +00:00
const binding = process.atomBinding('web_contents')
const {WebContents} = binding
Object.setPrototypeOf(NavigationController.prototype, EventEmitter.prototype)
Object.setPrototypeOf(WebContents.prototype, NavigationController.prototype)
2016-08-02 11:38:35 +00:00
// WebContents::send(channel, args..)
// WebContents::sendToAll(channel, args..)
WebContents.prototype.send = function (channel, ...args) {
if (channel == null) throw new Error('Missing required channel argument')
return this._send(false, channel, args)
}
WebContents.prototype.sendToAll = function (channel, ...args) {
if (channel == null) throw new Error('Missing required channel argument')
return this._send(true, channel, args)
}
2016-01-13 03:55:49 +00:00
// Following methods are mapped to webFrame.
const webFrameMethods = [
'insertText',
'setLayoutZoomLevelLimits',
'setVisualZoomLevelLimits',
'setZoomFactor',
'setZoomLevel',
// TODO(kevinsawicki): Remove in 2.0, deprecate before then with warnings
2016-01-19 22:49:40 +00:00
'setZoomLevelLimits'
]
const webFrameMethodsWithResult = [
'getZoomFactor',
'getZoomLevel'
]
const asyncWebFrameMethods = function (requestId, method, callback, ...args) {
return new Promise((resolve, reject) => {
this.send('ELECTRON_INTERNAL_RENDERER_ASYNC_WEB_FRAME_METHOD', requestId, method, args)
ipcMain.once(`ELECTRON_INTERNAL_BROWSER_ASYNC_WEB_FRAME_RESPONSE_${requestId}`, function (event, error, result) {
2016-11-03 16:51:01 +00:00
if (error == null) {
if (callback != null) callback(result)
resolve(result)
} else {
reject(error)
}
})
})
}
const syncWebFrameMethods = function (requestId, method, callback, ...args) {
this.send('ELECTRON_INTERNAL_RENDERER_SYNC_WEB_FRAME_METHOD', requestId, method, args)
ipcMain.once(`ELECTRON_INTERNAL_BROWSER_SYNC_WEB_FRAME_RESPONSE_${requestId}`, function (event, result) {
if (callback) callback(result)
})
}
for (const method of webFrameMethods) {
WebContents.prototype[method] = function (...args) {
this.send('ELECTRON_INTERNAL_RENDERER_WEB_FRAME_METHOD', method, args)
2016-01-12 02:40:23 +00:00
}
}
2016-01-12 02:40:23 +00:00
for (const method of webFrameMethodsWithResult) {
WebContents.prototype[method] = function (...args) {
const callback = args[args.length - 1]
const actualArgs = args.slice(0, args.length - 2)
syncWebFrameMethods.call(this, getNextId(), method, callback, ...actualArgs)
}
}
// Make sure WebContents::executeJavaScript would run the code only when the
// WebContents has been loaded.
WebContents.prototype.executeJavaScript = function (code, hasUserGesture, callback) {
const requestId = getNextId()
if (typeof hasUserGesture === 'function') {
callback = hasUserGesture
hasUserGesture = false
}
if (this.getURL() && !this.isLoadingMainFrame()) {
return asyncWebFrameMethods.call(this, requestId, 'executeJavaScript', callback, code, hasUserGesture)
} else {
return new Promise((resolve, reject) => {
this.once('did-finish-load', () => {
asyncWebFrameMethods.call(this, requestId, 'executeJavaScript', callback, code, hasUserGesture).then(resolve).catch(reject)
})
})
}
}
// Translate the options of printToPDF.
WebContents.prototype.printToPDF = function (options, callback) {
const printingSetting = Object.assign({}, defaultPrintingSetting)
if (options.landscape) {
printingSetting.landscape = options.landscape
}
if (options.marginsType) {
printingSetting.marginsType = options.marginsType
}
if (options.printSelectionOnly) {
printingSetting.shouldPrintSelectionOnly = options.printSelectionOnly
}
if (options.printBackground) {
printingSetting.shouldPrintBackgrounds = options.printBackground
2016-01-13 03:55:49 +00:00
}
if (options.pageSize) {
const pageSize = options.pageSize
if (typeof pageSize === 'object') {
if (!pageSize.height || !pageSize.width) {
return callback(new Error('Must define height and width for pageSize'))
}
// Dimensions in Microns
// 1 meter = 10^6 microns
printingSetting.mediaSize = {
name: 'CUSTOM',
custom_display_name: 'Custom',
height_microns: pageSize.height,
width_microns: pageSize.width
}
} else if (PDFPageSizes[pageSize]) {
printingSetting.mediaSize = PDFPageSizes[pageSize]
} else {
return callback(new Error(`Does not support pageSize with ${pageSize}`))
}
} else {
printingSetting.mediaSize = PDFPageSizes['A4']
}
2016-02-22 14:00:21 +00:00
this._printToPDF(printingSetting, callback)
}
// Add JavaScript wrappers for WebContents class.
WebContents.prototype._init = function () {
// The navigation controller.
NavigationController.call(this, this)
// Every remote callback from renderer process would add a listenter to the
// render-view-deleted event, so ignore the listenters warning.
this.setMaxListeners(0)
2016-01-14 18:35:29 +00:00
// Dispatch IPC messages to the ipc module.
2016-08-02 11:38:35 +00:00
this.on('ipc-message', function (event, [channel, ...args]) {
ipcMain.emit(channel, event, ...args)
})
2016-08-02 11:38:35 +00:00
this.on('ipc-message-sync', function (event, [channel, ...args]) {
2016-01-12 02:40:23 +00:00
Object.defineProperty(event, 'returnValue', {
set: function (value) {
return event.sendReply(JSON.stringify(value))
2016-03-30 21:06:50 +00:00
},
get: function () {}
})
ipcMain.emit(channel, event, ...args)
})
2016-01-12 02:40:23 +00:00
2016-01-14 18:35:29 +00:00
// Handle context menu action request from pepper plugin.
2016-08-02 11:38:35 +00:00
this.on('pepper-context-menu', function (event, params) {
// Access Menu via electron.Menu to prevent circular require
const menu = electron.Menu.buildFromTemplate(params.menu)
2016-05-19 22:28:08 +00:00
menu.popup(params.x, params.y)
})
2016-01-12 02:40:23 +00:00
// The devtools requests the webContents to reload.
2016-08-02 11:38:35 +00:00
this.on('devtools-reload-page', function () {
this.reload()
})
2016-01-14 18:35:29 +00:00
// Delays the page-title-updated event to next tick.
2016-08-02 11:38:35 +00:00
this.on('-page-title-updated', function (...args) {
setImmediate(() => {
this.emit('page-title-updated', ...args)
})
})
2016-01-12 02:40:23 +00:00
2016-08-02 11:38:35 +00:00
app.emit('web-contents-created', {}, this)
}
2016-01-12 02:40:23 +00:00
// JavaScript wrapper of Debugger.
2016-08-02 11:38:35 +00:00
const {Debugger} = process.atomBinding('debugger')
2016-01-23 04:02:21 +00:00
2016-08-02 11:38:35 +00:00
Object.setPrototypeOf(Debugger.prototype, EventEmitter.prototype)
2016-01-12 02:40:23 +00:00
2016-08-02 11:38:35 +00:00
// Public APIs.
2016-06-13 15:59:03 +00:00
module.exports = {
2016-06-13 16:06:42 +00:00
create (options = {}) {
2016-06-13 15:59:03 +00:00
return binding.create(options)
},
fromId (id) {
return binding.fromId(id)
2016-07-13 15:54:40 +00:00
},
getFocusedWebContents () {
let focused = null
2016-07-14 15:59:49 +00:00
for (let contents of binding.getAllWebContents()) {
if (!contents.isFocused()) continue
2016-07-13 21:49:25 +00:00
if (focused == null) focused = contents
// Return webview web contents which may be embedded inside another
// web contents that is also reporting as focused
if (contents.getType() === 'webview') return contents
}
return focused
2016-07-14 15:59:49 +00:00
},
getAllWebContents () {
return binding.getAllWebContents()
2016-06-13 15:59:03 +00:00
}
}