Move JavaScript to root lib/ folder
This commit is contained in:
Kevin Sawicki
parent
a9c40de393
commit
70aa9b06ee
56 changed files with 0 additions and 0 deletions
112
lib/renderer/web-view/guest-view-internal.js
Normal file
112
lib/renderer/web-view/guest-view-internal.js
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
const ipcRenderer = require('electron').ipcRenderer;
|
||||
const webFrame = require('electron').webFrame;
|
||||
|
||||
var slice = [].slice;
|
||||
var requestId = 0;
|
||||
|
||||
var WEB_VIEW_EVENTS = {
|
||||
'load-commit': ['url', 'isMainFrame'],
|
||||
'did-finish-load': [],
|
||||
'did-fail-load': ['errorCode', 'errorDescription', 'validatedURL'],
|
||||
'did-frame-finish-load': ['isMainFrame'],
|
||||
'did-start-loading': [],
|
||||
'did-stop-loading': [],
|
||||
'did-get-response-details': ['status', 'newURL', 'originalURL', 'httpResponseCode', 'requestMethod', 'referrer', 'headers'],
|
||||
'did-get-redirect-request': ['oldURL', 'newURL', 'isMainFrame'],
|
||||
'dom-ready': [],
|
||||
'console-message': ['level', 'message', 'line', 'sourceId'],
|
||||
'devtools-opened': [],
|
||||
'devtools-closed': [],
|
||||
'devtools-focused': [],
|
||||
'new-window': ['url', 'frameName', 'disposition', 'options'],
|
||||
'will-navigate': ['url'],
|
||||
'did-navigate': ['url'],
|
||||
'did-navigate-in-page': ['url'],
|
||||
'close': [],
|
||||
'crashed': [],
|
||||
'gpu-crashed': [],
|
||||
'plugin-crashed': ['name', 'version'],
|
||||
'media-started-playing': [],
|
||||
'media-paused': [],
|
||||
'did-change-theme-color': ['themeColor'],
|
||||
'destroyed': [],
|
||||
'page-title-updated': ['title', 'explicitSet'],
|
||||
'page-favicon-updated': ['favicons'],
|
||||
'enter-html-full-screen': [],
|
||||
'leave-html-full-screen': [],
|
||||
'found-in-page': ['result']
|
||||
};
|
||||
|
||||
var DEPRECATED_EVENTS = {
|
||||
'page-title-updated': 'page-title-set'
|
||||
};
|
||||
|
||||
var dispatchEvent = function() {
|
||||
var args, domEvent, eventKey, eventName, f, i, j, len, ref1, webView;
|
||||
webView = arguments[0], eventName = arguments[1], eventKey = arguments[2], args = 4 <= arguments.length ? slice.call(arguments, 3) : [];
|
||||
if (DEPRECATED_EVENTS[eventName] != null) {
|
||||
dispatchEvent.apply(null, [webView, DEPRECATED_EVENTS[eventName], eventKey].concat(slice.call(args)));
|
||||
}
|
||||
domEvent = new Event(eventName);
|
||||
ref1 = WEB_VIEW_EVENTS[eventKey];
|
||||
for (i = j = 0, len = ref1.length; j < len; i = ++j) {
|
||||
f = ref1[i];
|
||||
domEvent[f] = args[i];
|
||||
}
|
||||
webView.dispatchEvent(domEvent);
|
||||
if (eventName === 'load-commit') {
|
||||
return webView.onLoadCommit(domEvent);
|
||||
}
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
registerEvents: function(webView, viewInstanceId) {
|
||||
ipcRenderer.on("ATOM_SHELL_GUEST_VIEW_INTERNAL_DISPATCH_EVENT-" + viewInstanceId, function() {
|
||||
var eventName = arguments[1];
|
||||
var args = 3 <= arguments.length ? slice.call(arguments, 2) : [];
|
||||
return dispatchEvent.apply(null, [webView, eventName, eventName].concat(slice.call(args)));
|
||||
});
|
||||
ipcRenderer.on("ATOM_SHELL_GUEST_VIEW_INTERNAL_IPC_MESSAGE-" + viewInstanceId, function() {
|
||||
var channel = arguments[1];
|
||||
var args = 3 <= arguments.length ? slice.call(arguments, 2) : [];
|
||||
var domEvent = new Event('ipc-message');
|
||||
domEvent.channel = channel;
|
||||
domEvent.args = slice.call(args);
|
||||
return webView.dispatchEvent(domEvent);
|
||||
});
|
||||
return ipcRenderer.on("ATOM_SHELL_GUEST_VIEW_INTERNAL_SIZE_CHANGED-" + viewInstanceId, function() {
|
||||
var args, domEvent, f, i, j, len, ref1;
|
||||
args = 2 <= arguments.length ? slice.call(arguments, 1) : [];
|
||||
domEvent = new Event('size-changed');
|
||||
ref1 = ['oldWidth', 'oldHeight', 'newWidth', 'newHeight'];
|
||||
for (i = j = 0, len = ref1.length; j < len; i = ++j) {
|
||||
f = ref1[i];
|
||||
domEvent[f] = args[i];
|
||||
}
|
||||
return webView.onSizeChanged(domEvent);
|
||||
});
|
||||
},
|
||||
deregisterEvents: function(viewInstanceId) {
|
||||
ipcRenderer.removeAllListeners("ATOM_SHELL_GUEST_VIEW_INTERNAL_DISPATCH_EVENT-" + viewInstanceId);
|
||||
ipcRenderer.removeAllListeners("ATOM_SHELL_GUEST_VIEW_INTERNAL_IPC_MESSAGE-" + viewInstanceId);
|
||||
return ipcRenderer.removeAllListeners("ATOM_SHELL_GUEST_VIEW_INTERNAL_SIZE_CHANGED-" + viewInstanceId);
|
||||
},
|
||||
createGuest: function(params, callback) {
|
||||
requestId++;
|
||||
ipcRenderer.send('ATOM_SHELL_GUEST_VIEW_MANAGER_CREATE_GUEST', params, requestId);
|
||||
return ipcRenderer.once("ATOM_SHELL_RESPONSE_" + requestId, callback);
|
||||
},
|
||||
attachGuest: function(elementInstanceId, guestInstanceId, params) {
|
||||
ipcRenderer.send('ATOM_SHELL_GUEST_VIEW_MANAGER_ATTACH_GUEST', elementInstanceId, guestInstanceId, params);
|
||||
return webFrame.attachGuest(elementInstanceId);
|
||||
},
|
||||
destroyGuest: function(guestInstanceId) {
|
||||
return ipcRenderer.send('ATOM_SHELL_GUEST_VIEW_MANAGER_DESTROY_GUEST', guestInstanceId);
|
||||
},
|
||||
setSize: function(guestInstanceId, params) {
|
||||
return ipcRenderer.send('ATOM_SHELL_GUEST_VIEW_MANAGER_SET_SIZE', guestInstanceId, params);
|
||||
},
|
||||
setAllowTransparency: function(guestInstanceId, allowtransparency) {
|
||||
return ipcRenderer.send('ATOM_SHELL_GUEST_VIEW_MANAGER_SET_ALLOW_TRANSPARENCY', guestInstanceId, allowtransparency);
|
||||
}
|
||||
};
|
||||
321
lib/renderer/web-view/web-view-attributes.js
Normal file
321
lib/renderer/web-view/web-view-attributes.js
Normal file
|
|
@ -0,0 +1,321 @@
|
|||
'use strict';
|
||||
|
||||
const WebViewImpl = require('./web-view');
|
||||
const guestViewInternal = require('./guest-view-internal');
|
||||
const webViewConstants = require('./web-view-constants');
|
||||
const remote = require('electron').remote;
|
||||
|
||||
// Helper function to resolve url set in attribute.
|
||||
var a = document.createElement('a');
|
||||
|
||||
var resolveURL = function(url) {
|
||||
a.href = url;
|
||||
return a.href;
|
||||
};
|
||||
|
||||
// Attribute objects.
|
||||
// Default implementation of a WebView attribute.
|
||||
class WebViewAttribute {
|
||||
constructor(name, webViewImpl) {
|
||||
this.name = name;
|
||||
this.value = webViewImpl.webviewNode[name] || '';
|
||||
this.webViewImpl = webViewImpl;
|
||||
this.ignoreMutation = false;
|
||||
this.defineProperty();
|
||||
}
|
||||
|
||||
// Retrieves and returns the attribute's value.
|
||||
getValue() {
|
||||
return this.webViewImpl.webviewNode.getAttribute(this.name) || this.value;
|
||||
}
|
||||
|
||||
// Sets the attribute's value.
|
||||
setValue(value) {
|
||||
return this.webViewImpl.webviewNode.setAttribute(this.name, value || '');
|
||||
}
|
||||
|
||||
// Changes the attribute's value without triggering its mutation handler.
|
||||
setValueIgnoreMutation(value) {
|
||||
this.ignoreMutation = true;
|
||||
this.setValue(value);
|
||||
return this.ignoreMutation = false;
|
||||
}
|
||||
|
||||
// Defines this attribute as a property on the webview node.
|
||||
defineProperty() {
|
||||
return Object.defineProperty(this.webViewImpl.webviewNode, this.name, {
|
||||
get: (function(_this) {
|
||||
return function() {
|
||||
return _this.getValue();
|
||||
};
|
||||
})(this),
|
||||
set: (function(_this) {
|
||||
return function(value) {
|
||||
return _this.setValue(value);
|
||||
};
|
||||
})(this),
|
||||
enumerable: true
|
||||
});
|
||||
}
|
||||
|
||||
// Called when the attribute's value changes.
|
||||
handleMutation() {}
|
||||
}
|
||||
|
||||
// An attribute that is treated as a Boolean.
|
||||
class BooleanAttribute extends WebViewAttribute {
|
||||
constructor(name, webViewImpl) {
|
||||
super(name, webViewImpl);
|
||||
}
|
||||
|
||||
getValue() {
|
||||
return this.webViewImpl.webviewNode.hasAttribute(this.name);
|
||||
}
|
||||
|
||||
setValue(value) {
|
||||
if (!value) {
|
||||
return this.webViewImpl.webviewNode.removeAttribute(this.name);
|
||||
} else {
|
||||
return this.webViewImpl.webviewNode.setAttribute(this.name, '');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute that specifies whether transparency is allowed in the webview.
|
||||
class AllowTransparencyAttribute extends BooleanAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_ALLOWTRANSPARENCY, webViewImpl);
|
||||
}
|
||||
|
||||
handleMutation() {
|
||||
if (!this.webViewImpl.guestInstanceId) {
|
||||
return;
|
||||
}
|
||||
return guestViewInternal.setAllowTransparency(this.webViewImpl.guestInstanceId, this.getValue());
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute used to define the demension limits of autosizing.
|
||||
class AutosizeDimensionAttribute extends WebViewAttribute {
|
||||
constructor(name, webViewImpl) {
|
||||
super(name, webViewImpl);
|
||||
}
|
||||
|
||||
getValue() {
|
||||
return parseInt(this.webViewImpl.webviewNode.getAttribute(this.name)) || 0;
|
||||
}
|
||||
|
||||
handleMutation() {
|
||||
if (!this.webViewImpl.guestInstanceId) {
|
||||
return;
|
||||
}
|
||||
return guestViewInternal.setSize(this.webViewImpl.guestInstanceId, {
|
||||
enableAutoSize: this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_AUTOSIZE].getValue(),
|
||||
min: {
|
||||
width: parseInt(this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_MINWIDTH].getValue() || 0),
|
||||
height: parseInt(this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_MINHEIGHT].getValue() || 0)
|
||||
},
|
||||
max: {
|
||||
width: parseInt(this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_MAXWIDTH].getValue() || 0),
|
||||
height: parseInt(this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_MAXHEIGHT].getValue() || 0)
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Attribute that specifies whether the webview should be autosized.
|
||||
class AutosizeAttribute extends BooleanAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_AUTOSIZE, webViewImpl);
|
||||
}
|
||||
}
|
||||
|
||||
AutosizeAttribute.prototype.handleMutation = AutosizeDimensionAttribute.prototype.handleMutation;
|
||||
|
||||
// Attribute representing the state of the storage partition.
|
||||
class PartitionAttribute extends WebViewAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_PARTITION, webViewImpl);
|
||||
this.validPartitionId = true;
|
||||
}
|
||||
|
||||
handleMutation(oldValue, newValue) {
|
||||
newValue = newValue || '';
|
||||
|
||||
// The partition cannot change if the webview has already navigated.
|
||||
if (!this.webViewImpl.beforeFirstNavigation) {
|
||||
window.console.error(webViewConstants.ERROR_MSG_ALREADY_NAVIGATED);
|
||||
this.setValueIgnoreMutation(oldValue);
|
||||
return;
|
||||
}
|
||||
if (newValue === 'persist:') {
|
||||
this.validPartitionId = false;
|
||||
return window.console.error(webViewConstants.ERROR_MSG_INVALID_PARTITION_ATTRIBUTE);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute that handles the location and navigation of the webview.
|
||||
class SrcAttribute extends WebViewAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_SRC, webViewImpl);
|
||||
this.setupMutationObserver();
|
||||
}
|
||||
|
||||
getValue() {
|
||||
if (this.webViewImpl.webviewNode.hasAttribute(this.name)) {
|
||||
return resolveURL(this.webViewImpl.webviewNode.getAttribute(this.name));
|
||||
} else {
|
||||
return this.value;
|
||||
}
|
||||
}
|
||||
|
||||
setValueIgnoreMutation(value) {
|
||||
super.setValueIgnoreMutation(value);
|
||||
|
||||
// takeRecords() is needed to clear queued up src mutations. Without it, it
|
||||
// is possible for this change to get picked up asyncronously by src's
|
||||
// mutation observer |observer|, and then get handled even though we do not
|
||||
// want to handle this mutation.
|
||||
return this.observer.takeRecords();
|
||||
}
|
||||
|
||||
handleMutation(oldValue, newValue) {
|
||||
|
||||
// Once we have navigated, we don't allow clearing the src attribute.
|
||||
// Once <webview> enters a navigated state, it cannot return to a
|
||||
// placeholder state.
|
||||
if (!newValue && oldValue) {
|
||||
|
||||
// src attribute changes normally initiate a navigation. We suppress
|
||||
// the next src attribute handler call to avoid reloading the page
|
||||
// on every guest-initiated navigation.
|
||||
this.setValueIgnoreMutation(oldValue);
|
||||
return;
|
||||
}
|
||||
return this.parse();
|
||||
}
|
||||
|
||||
// The purpose of this mutation observer is to catch assignment to the src
|
||||
// attribute without any changes to its value. This is useful in the case
|
||||
// where the webview guest has crashed and navigating to the same address
|
||||
// spawns off a new process.
|
||||
setupMutationObserver() {
|
||||
var params;
|
||||
this.observer = new MutationObserver((function(_this) {
|
||||
return function(mutations) {
|
||||
var i, len, mutation, newValue, oldValue;
|
||||
for (i = 0, len = mutations.length; i < len; i++) {
|
||||
mutation = mutations[i];
|
||||
oldValue = mutation.oldValue;
|
||||
newValue = _this.getValue();
|
||||
if (oldValue !== newValue) {
|
||||
return;
|
||||
}
|
||||
_this.handleMutation(oldValue, newValue);
|
||||
}
|
||||
};
|
||||
})(this));
|
||||
params = {
|
||||
attributes: true,
|
||||
attributeOldValue: true,
|
||||
attributeFilter: [this.name]
|
||||
};
|
||||
return this.observer.observe(this.webViewImpl.webviewNode, params);
|
||||
}
|
||||
|
||||
parse() {
|
||||
var guestContents, httpreferrer, opts, useragent;
|
||||
if (!this.webViewImpl.elementAttached || !this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_PARTITION].validPartitionId || !this.getValue()) {
|
||||
return;
|
||||
}
|
||||
if (this.webViewImpl.guestInstanceId == null) {
|
||||
if (this.webViewImpl.beforeFirstNavigation) {
|
||||
this.webViewImpl.beforeFirstNavigation = false;
|
||||
this.webViewImpl.createGuest();
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// Navigate to |this.src|.
|
||||
opts = {};
|
||||
httpreferrer = this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER].getValue();
|
||||
if (httpreferrer) {
|
||||
opts.httpReferrer = httpreferrer;
|
||||
}
|
||||
useragent = this.webViewImpl.attributes[webViewConstants.ATTRIBUTE_USERAGENT].getValue();
|
||||
if (useragent) {
|
||||
opts.userAgent = useragent;
|
||||
}
|
||||
guestContents = remote.getGuestWebContents(this.webViewImpl.guestInstanceId);
|
||||
return guestContents.loadURL(this.getValue(), opts);
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute specifies HTTP referrer.
|
||||
class HttpReferrerAttribute extends WebViewAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_HTTPREFERRER, webViewImpl);
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute specifies user agent
|
||||
class UserAgentAttribute extends WebViewAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_USERAGENT, webViewImpl);
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute that set preload script.
|
||||
class PreloadAttribute extends WebViewAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_PRELOAD, webViewImpl);
|
||||
}
|
||||
|
||||
getValue() {
|
||||
var preload, protocol;
|
||||
if (!this.webViewImpl.webviewNode.hasAttribute(this.name)) {
|
||||
return this.value;
|
||||
}
|
||||
preload = resolveURL(this.webViewImpl.webviewNode.getAttribute(this.name));
|
||||
protocol = preload.substr(0, 5);
|
||||
if (protocol !== 'file:') {
|
||||
console.error(webViewConstants.ERROR_MSG_INVALID_PRELOAD_ATTRIBUTE);
|
||||
preload = '';
|
||||
}
|
||||
return preload;
|
||||
}
|
||||
}
|
||||
|
||||
// Attribute that specifies the blink features to be enabled.
|
||||
class BlinkFeaturesAttribute extends WebViewAttribute {
|
||||
constructor(webViewImpl) {
|
||||
super(webViewConstants.ATTRIBUTE_BLINKFEATURES, webViewImpl);
|
||||
}
|
||||
}
|
||||
|
||||
// Sets up all of the webview attributes.
|
||||
WebViewImpl.prototype.setupWebViewAttributes = function() {
|
||||
var attribute, autosizeAttributes, i, len, results;
|
||||
this.attributes = {};
|
||||
this.attributes[webViewConstants.ATTRIBUTE_ALLOWTRANSPARENCY] = new AllowTransparencyAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_AUTOSIZE] = new AutosizeAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_PARTITION] = new PartitionAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_SRC] = new SrcAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER] = new HttpReferrerAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_USERAGENT] = new UserAgentAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_NODEINTEGRATION] = new BooleanAttribute(webViewConstants.ATTRIBUTE_NODEINTEGRATION, this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_PLUGINS] = new BooleanAttribute(webViewConstants.ATTRIBUTE_PLUGINS, this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_DISABLEWEBSECURITY] = new BooleanAttribute(webViewConstants.ATTRIBUTE_DISABLEWEBSECURITY, this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_ALLOWPOPUPS] = new BooleanAttribute(webViewConstants.ATTRIBUTE_ALLOWPOPUPS, this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_PRELOAD] = new PreloadAttribute(this);
|
||||
this.attributes[webViewConstants.ATTRIBUTE_BLINKFEATURES] = new BlinkFeaturesAttribute(this);
|
||||
autosizeAttributes = [webViewConstants.ATTRIBUTE_MAXHEIGHT, webViewConstants.ATTRIBUTE_MAXWIDTH, webViewConstants.ATTRIBUTE_MINHEIGHT, webViewConstants.ATTRIBUTE_MINWIDTH];
|
||||
results = [];
|
||||
for (i = 0, len = autosizeAttributes.length; i < len; i++) {
|
||||
attribute = autosizeAttributes[i];
|
||||
results.push(this.attributes[attribute] = new AutosizeDimensionAttribute(attribute, this));
|
||||
}
|
||||
return results;
|
||||
};
|
||||
29
lib/renderer/web-view/web-view-constants.js
Normal file
29
lib/renderer/web-view/web-view-constants.js
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
module.exports = {
|
||||
// Attributes.
|
||||
ATTRIBUTE_ALLOWTRANSPARENCY: 'allowtransparency',
|
||||
ATTRIBUTE_AUTOSIZE: 'autosize',
|
||||
ATTRIBUTE_MAXHEIGHT: 'maxheight',
|
||||
ATTRIBUTE_MAXWIDTH: 'maxwidth',
|
||||
ATTRIBUTE_MINHEIGHT: 'minheight',
|
||||
ATTRIBUTE_MINWIDTH: 'minwidth',
|
||||
ATTRIBUTE_NAME: 'name',
|
||||
ATTRIBUTE_PARTITION: 'partition',
|
||||
ATTRIBUTE_SRC: 'src',
|
||||
ATTRIBUTE_HTTPREFERRER: 'httpreferrer',
|
||||
ATTRIBUTE_NODEINTEGRATION: 'nodeintegration',
|
||||
ATTRIBUTE_PLUGINS: 'plugins',
|
||||
ATTRIBUTE_DISABLEWEBSECURITY: 'disablewebsecurity',
|
||||
ATTRIBUTE_ALLOWPOPUPS: 'allowpopups',
|
||||
ATTRIBUTE_PRELOAD: 'preload',
|
||||
ATTRIBUTE_USERAGENT: 'useragent',
|
||||
ATTRIBUTE_BLINKFEATURES: 'blinkfeatures',
|
||||
|
||||
// Internal attribute.
|
||||
ATTRIBUTE_INTERNALINSTANCEID: 'internalinstanceid',
|
||||
|
||||
// Error messages.
|
||||
ERROR_MSG_ALREADY_NAVIGATED: 'The object has already navigated, so its partition cannot be changed.',
|
||||
ERROR_MSG_CANNOT_INJECT_SCRIPT: '<webview>: ' + 'Script cannot be injected into content until the page has loaded.',
|
||||
ERROR_MSG_INVALID_PARTITION_ATTRIBUTE: 'Invalid partition attribute.',
|
||||
ERROR_MSG_INVALID_PRELOAD_ATTRIBUTE: 'Only "file:" protocol is supported in "preload" attribute.'
|
||||
};
|
||||
478
lib/renderer/web-view/web-view.js
Normal file
478
lib/renderer/web-view/web-view.js
Normal file
|
|
@ -0,0 +1,478 @@
|
|||
'use strict';
|
||||
|
||||
const deprecate = require('electron').deprecate;
|
||||
const webFrame = require('electron').webFrame;
|
||||
const remote = require('electron').remote;
|
||||
const ipcRenderer = require('electron').ipcRenderer;
|
||||
|
||||
const v8Util = process.atomBinding('v8_util');
|
||||
const guestViewInternal = require('./guest-view-internal');
|
||||
const webViewConstants = require('./web-view-constants');
|
||||
|
||||
var hasProp = {}.hasOwnProperty;
|
||||
var slice = [].slice;
|
||||
|
||||
// ID generator.
|
||||
var nextId = 0;
|
||||
|
||||
var getNextId = function() {
|
||||
return ++nextId;
|
||||
};
|
||||
|
||||
// Represents the internal state of the WebView node.
|
||||
var WebViewImpl = (function() {
|
||||
function WebViewImpl(webviewNode) {
|
||||
var shadowRoot;
|
||||
this.webviewNode = webviewNode;
|
||||
v8Util.setHiddenValue(this.webviewNode, 'internal', this);
|
||||
this.attached = false;
|
||||
this.elementAttached = false;
|
||||
this.beforeFirstNavigation = true;
|
||||
|
||||
// on* Event handlers.
|
||||
this.on = {};
|
||||
this.browserPluginNode = this.createBrowserPluginNode();
|
||||
shadowRoot = this.webviewNode.createShadowRoot();
|
||||
shadowRoot.innerHTML = '<style>:host { display: flex; }</style>';
|
||||
this.setupWebViewAttributes();
|
||||
this.setupFocusPropagation();
|
||||
this.viewInstanceId = getNextId();
|
||||
shadowRoot.appendChild(this.browserPluginNode);
|
||||
|
||||
// Subscribe to host's zoom level changes.
|
||||
this.onZoomLevelChanged = (zoomLevel) => {
|
||||
this.webviewNode.setZoomLevel(zoomLevel);
|
||||
};
|
||||
webFrame.on('zoom-level-changed', this.onZoomLevelChanged);
|
||||
}
|
||||
|
||||
WebViewImpl.prototype.createBrowserPluginNode = function() {
|
||||
// We create BrowserPlugin as a custom element in order to observe changes
|
||||
// to attributes synchronously.
|
||||
var browserPluginNode;
|
||||
browserPluginNode = new WebViewImpl.BrowserPlugin();
|
||||
v8Util.setHiddenValue(browserPluginNode, 'internal', this);
|
||||
return browserPluginNode;
|
||||
};
|
||||
|
||||
// Resets some state upon reattaching <webview> element to the DOM.
|
||||
WebViewImpl.prototype.reset = function() {
|
||||
// Unlisten the zoom-level-changed event.
|
||||
webFrame.removeListener('zoom-level-changed', this.onZoomLevelChanged);
|
||||
|
||||
// If guestInstanceId is defined then the <webview> has navigated and has
|
||||
// already picked up a partition ID. Thus, we need to reset the initialization
|
||||
// state. However, it may be the case that beforeFirstNavigation is false BUT
|
||||
// guestInstanceId has yet to be initialized. This means that we have not
|
||||
// heard back from createGuest yet. We will not reset the flag in this case so
|
||||
// that we don't end up allocating a second guest.
|
||||
if (this.guestInstanceId) {
|
||||
guestViewInternal.destroyGuest(this.guestInstanceId);
|
||||
this.webContents = null;
|
||||
this.guestInstanceId = void 0;
|
||||
this.beforeFirstNavigation = true;
|
||||
this.attributes[webViewConstants.ATTRIBUTE_PARTITION].validPartitionId = true;
|
||||
}
|
||||
return this.internalInstanceId = 0;
|
||||
};
|
||||
|
||||
// Sets the <webview>.request property.
|
||||
WebViewImpl.prototype.setRequestPropertyOnWebViewNode = function(request) {
|
||||
return Object.defineProperty(this.webviewNode, 'request', {
|
||||
value: request,
|
||||
enumerable: true
|
||||
});
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.setupFocusPropagation = function() {
|
||||
if (!this.webviewNode.hasAttribute('tabIndex')) {
|
||||
|
||||
// <webview> needs a tabIndex in order to be focusable.
|
||||
// TODO(fsamuel): It would be nice to avoid exposing a tabIndex attribute
|
||||
// to allow <webview> to be focusable.
|
||||
// See http://crbug.com/231664.
|
||||
this.webviewNode.setAttribute('tabIndex', -1);
|
||||
}
|
||||
this.webviewNode.addEventListener('focus', (function(_this) {
|
||||
return function() {
|
||||
// Focus the BrowserPlugin when the <webview> takes focus.
|
||||
return _this.browserPluginNode.focus();
|
||||
};
|
||||
})(this));
|
||||
return this.webviewNode.addEventListener('blur', (function(_this) {
|
||||
return function() {
|
||||
// Blur the BrowserPlugin when the <webview> loses focus.
|
||||
return _this.browserPluginNode.blur();
|
||||
};
|
||||
})(this));
|
||||
};
|
||||
|
||||
|
||||
// This observer monitors mutations to attributes of the <webview> and
|
||||
// updates the BrowserPlugin properties accordingly. In turn, updating
|
||||
// a BrowserPlugin property will update the corresponding BrowserPlugin
|
||||
// attribute, if necessary. See BrowserPlugin::UpdateDOMAttribute for more
|
||||
// details.
|
||||
WebViewImpl.prototype.handleWebviewAttributeMutation = function(attributeName, oldValue, newValue) {
|
||||
if (!this.attributes[attributeName] || this.attributes[attributeName].ignoreMutation) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Let the changed attribute handle its own mutation;
|
||||
return this.attributes[attributeName].handleMutation(oldValue, newValue);
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.handleBrowserPluginAttributeMutation = function(attributeName, oldValue, newValue) {
|
||||
if (attributeName === webViewConstants.ATTRIBUTE_INTERNALINSTANCEID && !oldValue && !!newValue) {
|
||||
this.browserPluginNode.removeAttribute(webViewConstants.ATTRIBUTE_INTERNALINSTANCEID);
|
||||
this.internalInstanceId = parseInt(newValue);
|
||||
|
||||
// Track when the element resizes using the element resize callback.
|
||||
webFrame.registerElementResizeCallback(this.internalInstanceId, this.onElementResize.bind(this));
|
||||
if (!this.guestInstanceId) {
|
||||
return;
|
||||
}
|
||||
return guestViewInternal.attachGuest(this.internalInstanceId, this.guestInstanceId, this.buildParams());
|
||||
}
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.onSizeChanged = function(webViewEvent) {
|
||||
var maxHeight, maxWidth, minHeight, minWidth, newHeight, newWidth, node, width;
|
||||
newWidth = webViewEvent.newWidth;
|
||||
newHeight = webViewEvent.newHeight;
|
||||
node = this.webviewNode;
|
||||
width = node.offsetWidth;
|
||||
|
||||
// Check the current bounds to make sure we do not resize <webview>
|
||||
// outside of current constraints.
|
||||
maxWidth = this.attributes[webViewConstants.ATTRIBUTE_MAXWIDTH].getValue() | width;
|
||||
maxHeight = this.attributes[webViewConstants.ATTRIBUTE_MAXHEIGHT].getValue() | width;
|
||||
minWidth = this.attributes[webViewConstants.ATTRIBUTE_MINWIDTH].getValue() | width;
|
||||
minHeight = this.attributes[webViewConstants.ATTRIBUTE_MINHEIGHT].getValue() | width;
|
||||
minWidth = Math.min(minWidth, maxWidth);
|
||||
minHeight = Math.min(minHeight, maxHeight);
|
||||
if (!this.attributes[webViewConstants.ATTRIBUTE_AUTOSIZE].getValue() || (newWidth >= minWidth && newWidth <= maxWidth && newHeight >= minHeight && newHeight <= maxHeight)) {
|
||||
node.style.width = newWidth + 'px';
|
||||
node.style.height = newHeight + 'px';
|
||||
|
||||
// Only fire the DOM event if the size of the <webview> has actually
|
||||
// changed.
|
||||
return this.dispatchEvent(webViewEvent);
|
||||
}
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.onElementResize = function(newSize) {
|
||||
// Dispatch the 'resize' event.
|
||||
var resizeEvent;
|
||||
resizeEvent = new Event('resize', {
|
||||
bubbles: true
|
||||
});
|
||||
resizeEvent.newWidth = newSize.width;
|
||||
resizeEvent.newHeight = newSize.height;
|
||||
this.dispatchEvent(resizeEvent);
|
||||
if (this.guestInstanceId) {
|
||||
return guestViewInternal.setSize(this.guestInstanceId, {
|
||||
normal: newSize
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.createGuest = function() {
|
||||
return guestViewInternal.createGuest(this.buildParams(), (function(_this) {
|
||||
return function(event, guestInstanceId) {
|
||||
return _this.attachWindow(guestInstanceId);
|
||||
};
|
||||
})(this));
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.dispatchEvent = function(webViewEvent) {
|
||||
return this.webviewNode.dispatchEvent(webViewEvent);
|
||||
};
|
||||
|
||||
// Adds an 'on<event>' property on the webview, which can be used to set/unset
|
||||
// an event handler.
|
||||
WebViewImpl.prototype.setupEventProperty = function(eventName) {
|
||||
var propertyName;
|
||||
propertyName = 'on' + eventName.toLowerCase();
|
||||
return Object.defineProperty(this.webviewNode, propertyName, {
|
||||
get: (function(_this) {
|
||||
return function() {
|
||||
return _this.on[propertyName];
|
||||
};
|
||||
})(this),
|
||||
set: (function(_this) {
|
||||
return function(value) {
|
||||
if (_this.on[propertyName]) {
|
||||
_this.webviewNode.removeEventListener(eventName, _this.on[propertyName]);
|
||||
}
|
||||
_this.on[propertyName] = value;
|
||||
if (value) {
|
||||
return _this.webviewNode.addEventListener(eventName, value);
|
||||
}
|
||||
};
|
||||
})(this),
|
||||
enumerable: true
|
||||
});
|
||||
};
|
||||
|
||||
// Updates state upon loadcommit.
|
||||
WebViewImpl.prototype.onLoadCommit = function(webViewEvent) {
|
||||
var newValue, oldValue;
|
||||
oldValue = this.webviewNode.getAttribute(webViewConstants.ATTRIBUTE_SRC);
|
||||
newValue = webViewEvent.url;
|
||||
if (webViewEvent.isMainFrame && (oldValue !== newValue)) {
|
||||
|
||||
// Touching the src attribute triggers a navigation. To avoid
|
||||
// triggering a page reload on every guest-initiated navigation,
|
||||
// we do not handle this mutation.
|
||||
return this.attributes[webViewConstants.ATTRIBUTE_SRC].setValueIgnoreMutation(newValue);
|
||||
}
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.onAttach = function(storagePartitionId) {
|
||||
return this.attributes[webViewConstants.ATTRIBUTE_PARTITION].setValue(storagePartitionId);
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.buildParams = function() {
|
||||
var attribute, attributeName, css, elementRect, params, ref1;
|
||||
params = {
|
||||
instanceId: this.viewInstanceId,
|
||||
userAgentOverride: this.userAgentOverride
|
||||
};
|
||||
ref1 = this.attributes;
|
||||
for (attributeName in ref1) {
|
||||
if (!hasProp.call(ref1, attributeName)) continue;
|
||||
attribute = ref1[attributeName];
|
||||
params[attributeName] = attribute.getValue();
|
||||
}
|
||||
|
||||
// When the WebView is not participating in layout (display:none)
|
||||
// then getBoundingClientRect() would report a width and height of 0.
|
||||
// However, in the case where the WebView has a fixed size we can
|
||||
// use that value to initially size the guest so as to avoid a relayout of
|
||||
// the on display:block.
|
||||
css = window.getComputedStyle(this.webviewNode, null);
|
||||
elementRect = this.webviewNode.getBoundingClientRect();
|
||||
params.elementWidth = parseInt(elementRect.width) || parseInt(css.getPropertyValue('width'));
|
||||
params.elementHeight = parseInt(elementRect.height) || parseInt(css.getPropertyValue('height'));
|
||||
return params;
|
||||
};
|
||||
|
||||
WebViewImpl.prototype.attachWindow = function(guestInstanceId) {
|
||||
this.guestInstanceId = guestInstanceId;
|
||||
this.webContents = remote.getGuestWebContents(this.guestInstanceId);
|
||||
if (!this.internalInstanceId) {
|
||||
return true;
|
||||
}
|
||||
return guestViewInternal.attachGuest(this.internalInstanceId, this.guestInstanceId, this.buildParams());
|
||||
};
|
||||
|
||||
return WebViewImpl;
|
||||
|
||||
})();
|
||||
|
||||
// Registers browser plugin <object> custom element.
|
||||
var registerBrowserPluginElement = function() {
|
||||
var proto;
|
||||
proto = Object.create(HTMLObjectElement.prototype);
|
||||
proto.createdCallback = function() {
|
||||
this.setAttribute('type', 'application/browser-plugin');
|
||||
this.setAttribute('id', 'browser-plugin-' + getNextId());
|
||||
|
||||
// The <object> node fills in the <webview> container.
|
||||
return this.style.flex = '1 1 auto';
|
||||
};
|
||||
proto.attributeChangedCallback = function(name, oldValue, newValue) {
|
||||
var internal;
|
||||
internal = v8Util.getHiddenValue(this, 'internal');
|
||||
if (!internal) {
|
||||
return;
|
||||
}
|
||||
return internal.handleBrowserPluginAttributeMutation(name, oldValue, newValue);
|
||||
};
|
||||
proto.attachedCallback = function() {
|
||||
// Load the plugin immediately.
|
||||
return this.nonExistentAttribute;
|
||||
};
|
||||
WebViewImpl.BrowserPlugin = webFrame.registerEmbedderCustomElement('browserplugin', {
|
||||
"extends": 'object',
|
||||
prototype: proto
|
||||
});
|
||||
delete proto.createdCallback;
|
||||
delete proto.attachedCallback;
|
||||
delete proto.detachedCallback;
|
||||
return delete proto.attributeChangedCallback;
|
||||
};
|
||||
|
||||
// Registers <webview> custom element.
|
||||
var registerWebViewElement = function() {
|
||||
var createBlockHandler, createNonBlockHandler, i, j, len, len1, m, methods, nonblockMethods, proto;
|
||||
proto = Object.create(HTMLObjectElement.prototype);
|
||||
proto.createdCallback = function() {
|
||||
return new WebViewImpl(this);
|
||||
};
|
||||
proto.attributeChangedCallback = function(name, oldValue, newValue) {
|
||||
var internal;
|
||||
internal = v8Util.getHiddenValue(this, 'internal');
|
||||
if (!internal) {
|
||||
return;
|
||||
}
|
||||
return internal.handleWebviewAttributeMutation(name, oldValue, newValue);
|
||||
};
|
||||
proto.detachedCallback = function() {
|
||||
var internal;
|
||||
internal = v8Util.getHiddenValue(this, 'internal');
|
||||
if (!internal) {
|
||||
return;
|
||||
}
|
||||
guestViewInternal.deregisterEvents(internal.viewInstanceId);
|
||||
internal.elementAttached = false;
|
||||
return internal.reset();
|
||||
};
|
||||
proto.attachedCallback = function() {
|
||||
var internal;
|
||||
internal = v8Util.getHiddenValue(this, 'internal');
|
||||
if (!internal) {
|
||||
return;
|
||||
}
|
||||
if (!internal.elementAttached) {
|
||||
guestViewInternal.registerEvents(internal, internal.viewInstanceId);
|
||||
internal.elementAttached = true;
|
||||
return internal.attributes[webViewConstants.ATTRIBUTE_SRC].parse();
|
||||
}
|
||||
};
|
||||
|
||||
// Public-facing API methods.
|
||||
methods = [
|
||||
'getURL',
|
||||
'loadURL',
|
||||
'getTitle',
|
||||
'isLoading',
|
||||
'isWaitingForResponse',
|
||||
'stop',
|
||||
'reload',
|
||||
'reloadIgnoringCache',
|
||||
'canGoBack',
|
||||
'canGoForward',
|
||||
'canGoToOffset',
|
||||
'clearHistory',
|
||||
'goBack',
|
||||
'goForward',
|
||||
'goToIndex',
|
||||
'goToOffset',
|
||||
'isCrashed',
|
||||
'setUserAgent',
|
||||
'getUserAgent',
|
||||
'openDevTools',
|
||||
'closeDevTools',
|
||||
'isDevToolsOpened',
|
||||
'isDevToolsFocused',
|
||||
'inspectElement',
|
||||
'setAudioMuted',
|
||||
'isAudioMuted',
|
||||
'undo',
|
||||
'redo',
|
||||
'cut',
|
||||
'copy',
|
||||
'paste',
|
||||
'pasteAndMatchStyle',
|
||||
'delete',
|
||||
'selectAll',
|
||||
'unselect',
|
||||
'replace',
|
||||
'replaceMisspelling',
|
||||
'findInPage',
|
||||
'stopFindInPage',
|
||||
'getId',
|
||||
'downloadURL',
|
||||
'inspectServiceWorker',
|
||||
'print',
|
||||
'printToPDF',
|
||||
];
|
||||
nonblockMethods = [
|
||||
'insertCSS',
|
||||
'insertText',
|
||||
'send',
|
||||
'sendInputEvent',
|
||||
'setZoomFactor',
|
||||
'setZoomLevel',
|
||||
'setZoomLevelLimits',
|
||||
];
|
||||
|
||||
// Forward proto.foo* method calls to WebViewImpl.foo*.
|
||||
createBlockHandler = function(m) {
|
||||
return function() {
|
||||
var args = 1 <= arguments.length ? slice.call(arguments, 0) : [];
|
||||
var internal = v8Util.getHiddenValue(this, 'internal');
|
||||
if (internal.webContents) {
|
||||
return internal.webContents[m].apply(internal.webContents, args);
|
||||
} else {
|
||||
throw new Error(`Cannot call ${m} because the webContents is unavailable. The WebView must be attached to the DOM and the dom-ready event emitted before this method can be called.`);
|
||||
}
|
||||
};
|
||||
};
|
||||
for (i = 0, len = methods.length; i < len; i++) {
|
||||
m = methods[i];
|
||||
proto[m] = createBlockHandler(m);
|
||||
}
|
||||
createNonBlockHandler = function(m) {
|
||||
return function() {
|
||||
var args, internal;
|
||||
args = 1 <= arguments.length ? slice.call(arguments, 0) : [];
|
||||
internal = v8Util.getHiddenValue(this, 'internal');
|
||||
return ipcRenderer.send.apply(ipcRenderer, ['ATOM_BROWSER_ASYNC_CALL_TO_GUEST_VIEW', null, internal.guestInstanceId, m].concat(slice.call(args)));
|
||||
};
|
||||
};
|
||||
for (j = 0, len1 = nonblockMethods.length; j < len1; j++) {
|
||||
m = nonblockMethods[j];
|
||||
proto[m] = createNonBlockHandler(m);
|
||||
}
|
||||
|
||||
proto.executeJavaScript = function(code, hasUserGesture, callback) {
|
||||
var internal = v8Util.getHiddenValue(this, 'internal');
|
||||
if (typeof hasUserGesture === "function") {
|
||||
callback = hasUserGesture;
|
||||
hasUserGesture = false;
|
||||
}
|
||||
let requestId = getNextId();
|
||||
ipcRenderer.send('ATOM_BROWSER_ASYNC_CALL_TO_GUEST_VIEW', requestId, internal.guestInstanceId, "executeJavaScript", code, hasUserGesture);
|
||||
ipcRenderer.once(`ATOM_RENDERER_ASYNC_CALL_TO_GUEST_VIEW_RESPONSE_${requestId}`, function(event, result) {
|
||||
if (callback)
|
||||
callback(result);
|
||||
});
|
||||
};
|
||||
|
||||
// WebContents associated with this webview.
|
||||
proto.getWebContents = function() {
|
||||
var internal = v8Util.getHiddenValue(this, 'internal');
|
||||
return internal.webContents;
|
||||
};
|
||||
|
||||
// Deprecated.
|
||||
deprecate.rename(proto, 'getUrl', 'getURL');
|
||||
window.WebView = webFrame.registerEmbedderCustomElement('webview', {
|
||||
prototype: proto
|
||||
});
|
||||
|
||||
// Delete the callbacks so developers cannot call them and produce unexpected
|
||||
// behavior.
|
||||
delete proto.createdCallback;
|
||||
delete proto.attachedCallback;
|
||||
delete proto.detachedCallback;
|
||||
return delete proto.attributeChangedCallback;
|
||||
};
|
||||
|
||||
var useCapture = true;
|
||||
|
||||
var listener = function(event) {
|
||||
if (document.readyState === 'loading') {
|
||||
return;
|
||||
}
|
||||
registerBrowserPluginElement();
|
||||
registerWebViewElement();
|
||||
return window.removeEventListener(event.type, listener, useCapture);
|
||||
};
|
||||
|
||||
window.addEventListener('readystatechange', listener, true);
|
||||
|
||||
module.exports = WebViewImpl;
|
||||
Loading…
Add table
Add a link
Reference in a new issue