import type * as guestViewInternalModule from '@electron/internal/renderer/web-view/guest-view-internal'; import { WEB_VIEW_CONSTANTS } from '@electron/internal/renderer/web-view/web-view-constants'; import { syncMethods, asyncMethods, properties } from '@electron/internal/common/web-view-methods'; import type { WebViewAttribute, PartitionAttribute } from '@electron/internal/renderer/web-view/web-view-attributes'; import { setupWebViewAttributes } from '@electron/internal/renderer/web-view/web-view-attributes'; // ID generator. let nextId = 0; const getNextId = function () { return ++nextId; }; export interface WebViewImplHooks { readonly guestViewInternal: typeof guestViewInternalModule; readonly allowGuestViewElementDefinition: NodeJS.InternalWebFrame['allowGuestViewElementDefinition']; readonly setIsWebView: (iframe: HTMLIFrameElement) => void; } // Represents the internal state of the WebView node. export class WebViewImpl { public beforeFirstNavigation = true public elementAttached = false public guestInstanceId?: number public hasFocus = false public internalInstanceId?: number; public resizeObserver?: ResizeObserver; public viewInstanceId: number // on* Event handlers. public on: Record = {} public internalElement: HTMLIFrameElement public attributes: Map; constructor (public webviewNode: HTMLElement, private hooks: WebViewImplHooks) { // Create internal iframe element. this.internalElement = this.createInternalElement(); const shadowRoot = this.webviewNode.attachShadow({ mode: 'open' }); const style = shadowRoot.ownerDocument.createElement('style'); style.textContent = ':host { display: flex; }'; shadowRoot.appendChild(style); this.attributes = setupWebViewAttributes(this); this.viewInstanceId = getNextId(); shadowRoot.appendChild(this.internalElement); // Provide access to contentWindow. Object.defineProperty(this.webviewNode, 'contentWindow', { get: () => { return this.internalElement.contentWindow; }, enumerable: true }); } createInternalElement () { const iframeElement = document.createElement('iframe'); iframeElement.style.flex = '1 1 auto'; iframeElement.style.width = '100%'; iframeElement.style.border = '0'; // used by RendererClientBase::IsWebViewFrame this.hooks.setIsWebView(iframeElement); return iframeElement; } // Resets some state upon reattaching element to the DOM. reset () { // If guestInstanceId is defined then the 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) { this.guestInstanceId = undefined; } this.beforeFirstNavigation = true; (this.attributes.get(WEB_VIEW_CONSTANTS.ATTRIBUTE_PARTITION) as PartitionAttribute).validPartitionId = true; // Since attachment swaps a local frame for a remote frame, we need our // internal iframe element to be local again before we can reattach. const newFrame = this.createInternalElement(); const oldFrame = this.internalElement; this.internalElement = newFrame; if (oldFrame && oldFrame.parentNode) { oldFrame.parentNode.replaceChild(newFrame, oldFrame); } } // This observer monitors mutations to attributes of the 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. handleWebviewAttributeMutation (attributeName: string, oldValue: any, newValue: any) { if (!this.attributes.has(attributeName) || this.attributes.get(attributeName)!.ignoreMutation) { return; } // Let the changed attribute handle its own mutation this.attributes.get(attributeName)!.handleMutation(oldValue, newValue); } onElementResize () { const props = { newWidth: this.webviewNode.clientWidth, newHeight: this.webviewNode.clientHeight }; this.dispatchEvent('resize', props); } createGuest () { this.internalInstanceId = getNextId(); this.hooks.guestViewInternal.createGuest(this.internalElement, this.internalInstanceId, this.buildParams()) .then(guestInstanceId => { this.attachGuestInstance(guestInstanceId); }); } dispatchEvent (eventName: string, props: Record = {}) { const event = new Event(eventName); Object.assign(event, props); this.webviewNode.dispatchEvent(event); if (eventName === 'load-commit') { this.onLoadCommit(props); } else if (eventName === '-focus-change') { this.onFocusChange(); } } // Adds an 'on' property on the webview, which can be used to set/unset // an event handler. setupEventProperty (eventName: string) { const propertyName = `on${eventName.toLowerCase()}`; return Object.defineProperty(this.webviewNode, propertyName, { get: () => { return this.on[propertyName]; }, set: (value) => { if (this.on[propertyName]) { this.webviewNode.removeEventListener(eventName, this.on[propertyName]); } this.on[propertyName] = value; if (value) { return this.webviewNode.addEventListener(eventName, value); } }, enumerable: true }); } // Updates state upon loadcommit. onLoadCommit (props: Record) { const oldValue = this.webviewNode.getAttribute(WEB_VIEW_CONSTANTS.ATTRIBUTE_SRC); const newValue = props.url; if (props.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. this.attributes.get(WEB_VIEW_CONSTANTS.ATTRIBUTE_SRC)!.setValueIgnoreMutation(newValue); } } // Emits focus/blur events. onFocusChange () { const hasFocus = this.webviewNode.ownerDocument.activeElement === this.webviewNode; if (hasFocus !== this.hasFocus) { this.hasFocus = hasFocus; this.dispatchEvent(hasFocus ? 'focus' : 'blur'); } } onAttach (storagePartitionId: number) { return this.attributes.get(WEB_VIEW_CONSTANTS.ATTRIBUTE_PARTITION)!.setValue(storagePartitionId); } buildParams () { const params: Record = { instanceId: this.viewInstanceId }; for (const [attributeName, attribute] of this.attributes) { params[attributeName] = attribute.getValue(); } return params; } attachGuestInstance (guestInstanceId: number) { if (guestInstanceId === -1) { this.dispatchEvent('destroyed'); return; } if (!this.elementAttached) { // The element could be detached before we got response from browser. // Destroy the backing webContents to avoid any zombie nodes in the frame tree. this.hooks.guestViewInternal.detachGuest(guestInstanceId); return; } this.guestInstanceId = guestInstanceId; // TODO(zcbenz): Should we deprecate the "resize" event? Wait, it is not // even documented. this.resizeObserver = new ResizeObserver(this.onElementResize.bind(this)); this.resizeObserver.observe(this.internalElement); } } // I wish eslint wasn't so stupid, but it is // eslint-disable-next-line export const setupMethods = (WebViewElement: typeof ElectronInternal.WebViewElement, hooks: WebViewImplHooks) => { // Focusing the webview should move page focus to the underlying iframe. WebViewElement.prototype.focus = function () { this.contentWindow.focus(); }; // Forward proto.foo* method calls to WebViewImpl.foo*. for (const method of syncMethods) { (WebViewElement.prototype as Record)[method] = function (this: ElectronInternal.WebViewElement, ...args: Array) { return hooks.guestViewInternal.invokeSync(this.getWebContentsId(), method, args); }; } for (const method of asyncMethods) { (WebViewElement.prototype as Record)[method] = function (this: ElectronInternal.WebViewElement, ...args: Array) { return hooks.guestViewInternal.invoke(this.getWebContentsId(), method, args); }; } const createPropertyGetter = function (property: string) { return function (this: ElectronInternal.WebViewElement) { return hooks.guestViewInternal.propertyGet(this.getWebContentsId(), property); }; }; const createPropertySetter = function (property: string) { return function (this: ElectronInternal.WebViewElement, arg: any) { return hooks.guestViewInternal.propertySet(this.getWebContentsId(), property, arg); }; }; for (const property of properties) { Object.defineProperty(WebViewElement.prototype, property, { get: createPropertyGetter(property), set: createPropertySetter(property) }); } };