Home Explore 引导页 在线工具 Blog
Register Sign In
Pchen0
/
electron
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: 4-0-x
Branches Tags
electron
/
lib
/
renderer
/
web-view
/
web-view.js

web-view.js 12 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346 
  1. 'use strict'
    2. 

  2. 

  3. const { webFrame } = require('electron')
    4. 

  4. 

  5. const v8Util = process.atomBinding('v8_util')
    6. 

  6. const ipcRenderer = require('@electron/internal/renderer/ipc-renderer-internal')
    7. 

  7. const guestViewInternal = require('@electron/internal/renderer/web-view/guest-view-internal')
    8. 

  8. const webViewConstants = require('@electron/internal/renderer/web-view/web-view-constants')
    9. 

  9. const errorUtils = require('@electron/internal/common/error-utils')
    10. 

  10. const {
    11. 

  11.   syncMethods,
    12. 

  12.   asyncCallbackMethods,
    13. 

  13.   asyncPromiseMethods
    14. 

  14. } = require('@electron/internal/common/web-view-methods')
    15. 

  15. 

  16. // ID generator.
    17. 

  17. let nextId = 0
    18. 

  18. 

  19. const getNextId = function () {
    20. 

  20.   return ++nextId
    21. 

  21. }
    22. 

  22. 

  23. // Represents the internal state of the WebView node.
    24. 

  24. class WebViewImpl {
    25. 

  25.   constructor (webviewNode) {
    26. 

  26.     this.webviewNode = webviewNode
    27. 

  27.     v8Util.setHiddenValue(this.webviewNode, 'internal', this)
    28. 

  28.     this.elementAttached = false
    29. 

  29.     this.beforeFirstNavigation = true
    30. 

  30.     this.hasFocus = false
    31. 

  31. 

  32.     // on* Event handlers.
    33. 

  33.     this.on = {}
    34. 

  34. 

  35.     // Create internal iframe element.
    36. 

  36.     this.internalElement = this.createInternalElement()
    37. 

  37.     const shadowRoot = this.webviewNode.attachShadow({ mode: 'open' })
    38. 

  38.     shadowRoot.innerHTML = '<!DOCTYPE html><style type="text/css">:host { display: flex; }</style>'
    39. 

  39.     this.setupWebViewAttributes()
    40. 

  40.     this.viewInstanceId = getNextId()
    41. 

  41.     shadowRoot.appendChild(this.internalElement)
    42. 

  42. 

  43.     // Provide access to contentWindow.
    44. 

  44.     Object.defineProperty(this.webviewNode, 'contentWindow', {
    45. 

  45.       get: () => {
    46. 

  46.         return this.internalElement.contentWindow
    47. 

  47.       },
    48. 

  48.       enumerable: true
    49. 

  49.     })
    50. 

  50.   }
    51. 

  51. 

  52.   createInternalElement () {
    53. 

  53.     const iframeElement = document.createElement('iframe')
    54. 

  54.     iframeElement.style.flex = '1 1 auto'
    55. 

  55.     iframeElement.style.width = '100%'
    56. 

  56.     iframeElement.style.border = '0'
    57. 

  57.     v8Util.setHiddenValue(iframeElement, 'internal', this)
    58. 

  58.     return iframeElement
    59. 

  59.   }
    60. 

  60. 

  61.   // Resets some state upon reattaching <webview> element to the DOM.
    62. 

  62.   reset () {
    63. 

  63.     // If guestInstanceId is defined then the <webview> has navigated and has
    64. 

  64.     // already picked up a partition ID. Thus, we need to reset the initialization
    65. 

  65.     // state. However, it may be the case that beforeFirstNavigation is false BUT
    66. 

  66.     // guestInstanceId has yet to be initialized. This means that we have not
    67. 

  67.     // heard back from createGuest yet. We will not reset the flag in this case so
    68. 

  68.     // that we don't end up allocating a second guest.
    69. 

  69.     if (this.guestInstanceId) {
    70. 

  70.       guestViewInternal.destroyGuest(this.guestInstanceId)
    71. 

  71.       this.guestInstanceId = void 0
    72. 

  72.     }
    73. 

  73. 

  74.     this.beforeFirstNavigation = true
    75. 

  75.     this.attributes[webViewConstants.ATTRIBUTE_PARTITION].validPartitionId = true
    76. 

  76. 

  77.     // Since attachment swaps a local frame for a remote frame, we need our
    78. 

  78.     // internal iframe element to be local again before we can reattach.
    79. 

  79.     const newFrame = this.createInternalElement()
    80. 

  80.     const oldFrame = this.internalElement
    81. 

  81.     this.internalElement = newFrame
    82. 

  82.     oldFrame.parentNode.replaceChild(newFrame, oldFrame)
    83. 

  83.   }
    84. 

  84. 

  85.   // Sets the <webview>.request property.
    86. 

  86.   setRequestPropertyOnWebViewNode (request) {
    87. 

  87.     Object.defineProperty(this.webviewNode, 'request', {
    88. 

  88.       value: request,
    89. 

  89.       enumerable: true
    90. 

  90.     })
    91. 

  91.   }
    92. 

  92. 

  93.   // This observer monitors mutations to attributes of the <webview> and
    94. 

  94.   // updates the BrowserPlugin properties accordingly. In turn, updating
    95. 

  95.   // a BrowserPlugin property will update the corresponding BrowserPlugin
    96. 

  96.   // attribute, if necessary. See BrowserPlugin::UpdateDOMAttribute for more
    97. 

  97.   // details.
    98. 

  98.   handleWebviewAttributeMutation (attributeName, oldValue, newValue) {
    99. 

  99.     if (!this.attributes[attributeName] || this.attributes[attributeName].ignoreMutation) {
    100. 

  100.       return
    101. 

  101.     }
    102. 

  102. 

  103.     // Let the changed attribute handle its own mutation
    104. 

  104.     this.attributes[attributeName].handleMutation(oldValue, newValue)
    105. 

  105.   }
    106. 

  106. 

  107.   onElementResize () {
    108. 

  108.     const resizeEvent = new Event('resize')
    109. 

  109.     resizeEvent.newWidth = this.webviewNode.clientWidth
    110. 

  110.     resizeEvent.newHeight = this.webviewNode.clientHeight
    111. 

  111.     this.dispatchEvent(resizeEvent)
    112. 

  112.   }
    113. 

  113. 

  114.   createGuest () {
    115. 

  115.     return guestViewInternal.createGuest(this.buildParams(), (event, guestInstanceId) => {
    116. 

  116.       this.attachGuestInstance(guestInstanceId)
    117. 

  117.     })
    118. 

  118.   }
    119. 

  119. 

  120.   createGuestSync () {
    121. 

  121.     this.beforeFirstNavigation = false
    122. 

  122.     this.attachGuestInstance(guestViewInternal.createGuestSync(this.buildParams()))
    123. 

  123.   }
    124. 

  124. 

  125.   dispatchEvent (webViewEvent) {
    126. 

  126.     this.webviewNode.dispatchEvent(webViewEvent)
    127. 

  127.   }
    128. 

  128. 

  129.   // Adds an 'on<event>' property on the webview, which can be used to set/unset
    130. 

  130.   // an event handler.
    131. 

  131.   setupEventProperty (eventName) {
    132. 

  132.     const propertyName = `on${eventName.toLowerCase()}`
    133. 

  133.     return Object.defineProperty(this.webviewNode, propertyName, {
    134. 

  134.       get: () => {
    135. 

  135.         return this.on[propertyName]
    136. 

  136.       },
    137. 

  137.       set: (value) => {
    138. 

  138.         if (this.on[propertyName]) {
    139. 

  139.           this.webviewNode.removeEventListener(eventName, this.on[propertyName])
    140. 

  140.         }
    141. 

  141.         this.on[propertyName] = value
    142. 

  142.         if (value) {
    143. 

  143.           return this.webviewNode.addEventListener(eventName, value)
    144. 

  144.         }
    145. 

  145.       },
    146. 

  146.       enumerable: true
    147. 

  147.     })
    148. 

  148.   }
    149. 

  149. 

  150.   // Updates state upon loadcommit.
    151. 

  151.   onLoadCommit (webViewEvent) {
    152. 

  152.     const oldValue = this.webviewNode.getAttribute(webViewConstants.ATTRIBUTE_SRC)
    153. 

  153.     const newValue = webViewEvent.url
    154. 

  154.     if (webViewEvent.isMainFrame && (oldValue !== newValue)) {
    155. 

  155.       // Touching the src attribute triggers a navigation. To avoid
    156. 

  156.       // triggering a page reload on every guest-initiated navigation,
    157. 

  157.       // we do not handle this mutation.
    158. 

  158.       this.attributes[webViewConstants.ATTRIBUTE_SRC].setValueIgnoreMutation(newValue)
    159. 

  159.     }
    160. 

  160.   }
    161. 

  161. 

  162.   // Emits focus/blur events.
    163. 

  163.   onFocusChange () {
    164. 

  164.     const hasFocus = document.activeElement === this.webviewNode
    165. 

  165.     if (hasFocus !== this.hasFocus) {
    166. 

  166.       this.hasFocus = hasFocus
    167. 

  167.       this.dispatchEvent(new Event(hasFocus ? 'focus' : 'blur'))
    168. 

  168.     }
    169. 

  169.   }
    170. 

  170. 

  171.   onAttach (storagePartitionId) {
    172. 

  172.     return this.attributes[webViewConstants.ATTRIBUTE_PARTITION].setValue(storagePartitionId)
    173. 

  173.   }
    174. 

  174. 

  175.   buildParams () {
    176. 

  176.     const params = {
    177. 

  177.       instanceId: this.viewInstanceId,
    178. 

  178.       userAgentOverride: this.userAgentOverride
    179. 

  179.     }
    180. 

  180.     for (const attributeName in this.attributes) {
    181. 

  181.       if (this.attributes.hasOwnProperty(attributeName)) {
    182. 

  182.         params[attributeName] = this.attributes[attributeName].getValue()
    183. 

  183.       }
    184. 

  184.     }
    185. 

  185.     return params
    186. 

  186.   }
    187. 

  187. 

  188.   attachGuestInstance (guestInstanceId) {
    189. 

  189.     if (!this.elementAttached) {
    190. 

  190.       // The element could be detached before we got response from browser.
    191. 

  191.       return
    192. 

  192.     }
    193. 

  193.     this.internalInstanceId = getNextId()
    194. 

  194.     this.guestInstanceId = guestInstanceId
    195. 

  195.     guestViewInternal.attachGuest(this.internalInstanceId, this.guestInstanceId, this.buildParams(), this.internalElement.contentWindow)
    196. 

  196.     // ResizeObserver is a browser global not recognized by "standard".
    197. 

  197.     /* globals ResizeObserver */
    198. 

  198.     // TODO(zcbenz): Should we deprecate the "resize" event? Wait, it is not
    199. 

  199.     // even documented.
    200. 

  200.     this.resizeObserver = new ResizeObserver(this.onElementResize.bind(this)).observe(this.internalElement)
    201. 

  201.   }
    202. 

  202. }
    203. 

  203. 

  204. // Registers <webview> custom element.
    205. 

  205. const registerWebViewElement = (window) => {
    206. 

  206.   const proto = Object.create(window.HTMLObjectElement.prototype)
    207. 

  207.   proto.createdCallback = function () {
    208. 

  208.     return new WebViewImpl(this)
    209. 

  209.   }
    210. 

  210.   proto.attributeChangedCallback = function (name, oldValue, newValue) {
    211. 

  211.     const internal = v8Util.getHiddenValue(this, 'internal')
    212. 

  212.     if (internal) {
    213. 

  213.       internal.handleWebviewAttributeMutation(name, oldValue, newValue)
    214. 

  214.     }
    215. 

  215.   }
    216. 

  216.   proto.detachedCallback = function () {
    217. 

  217.     const internal = v8Util.getHiddenValue(this, 'internal')
    218. 

  218.     if (!internal) {
    219. 

  219.       return
    220. 

  220.     }
    221. 

  221.     guestViewInternal.deregisterEvents(internal.viewInstanceId)
    222. 

  222.     internal.elementAttached = false
    223. 

  223.     this.internalInstanceId = 0
    224. 

  224.     internal.reset()
    225. 

  225.   }
    226. 

  226.   proto.attachedCallback = function () {
    227. 

  227.     const internal = v8Util.getHiddenValue(this, 'internal')
    228. 

  228.     if (!internal) {
    229. 

  229.       return
    230. 

  230.     }
    231. 

  231.     if (!internal.elementAttached) {
    232. 

  232.       guestViewInternal.registerEvents(internal, internal.viewInstanceId)
    233. 

  233.       internal.elementAttached = true
    234. 

  234.       internal.attributes[webViewConstants.ATTRIBUTE_SRC].parse()
    235. 

  235.     }
    236. 

  236.   }
    237. 

  237. 

  238.   const getGuestInstanceId = function (self) {
    239. 

  239.     const internal = v8Util.getHiddenValue(self, 'internal')
    240. 

  240.     if (!internal.guestInstanceId) {
    241. 

  241.       throw new Error('The WebView must be attached to the DOM and the dom-ready event emitted before this method can be called.')
    242. 

  242.     }
    243. 

  243.     return internal.guestInstanceId
    244. 

  244.   }
    245. 

  245. 

  246.   // Forward proto.foo* method calls to WebViewImpl.foo*.
    247. 

  247.   const createBlockHandler = function (method) {
    248. 

  248.     return function (...args) {
    249. 

  249.       const [error, result] = ipcRenderer.sendSync('ELECTRON_GUEST_VIEW_MANAGER_SYNC_CALL', getGuestInstanceId(this), method, args)
    250. 

  250.       if (error) {
    251. 

  251.         throw errorUtils.deserialize(error)
    252. 

  252.       } else {
    253. 

  253.         return result
    254. 

  254.       }
    255. 

  255.     }
    256. 

  256.   }
    257. 

  257.   for (const method of syncMethods) {
    258. 

  258.     proto[method] = createBlockHandler(method)
    259. 

  259.   }
    260. 

  260. 

  261.   const createNonBlockHandler = function (method) {
    262. 

  262.     return function (...args) {
    263. 

  263.       const callback = (typeof args[args.length - 1] === 'function') ? args.pop() : null
    264. 

  264.       const requestId = getNextId()
    265. 

  265.       ipcRenderer.once(`ELECTRON_GUEST_VIEW_MANAGER_ASYNC_CALL_RESPONSE_${requestId}`, function (event, error, result) {
    266. 

  266.         if (error == null) {
    267. 

  267.           if (callback) callback(result)
    268. 

  268.         } else {
    269. 

  269.           throw errorUtils.deserialize(error)
    270. 

  270.         }
    271. 

  271.       })
    272. 

  272.       ipcRenderer.send('ELECTRON_GUEST_VIEW_MANAGER_ASYNC_CALL', requestId, getGuestInstanceId(this), method, args, callback != null)
    273. 

  273.     }
    274. 

  274.   }
    275. 

  275. 

  276.   for (const method of asyncCallbackMethods) {
    277. 

  277.     proto[method] = createNonBlockHandler(method)
    278. 

  278.   }
    279. 

  279. 

  280.   const createPromiseHandler = function (method) {
    281. 

  281.     return function (...args) {
    282. 

  282.       return new Promise((resolve, reject) => {
    283. 

  283.         const callback = (typeof args[args.length - 1] === 'function') ? args.pop() : null
    284. 

  284.         const requestId = getNextId()
    285. 

  285. 

  286.         ipcRenderer.once(`ELECTRON_GUEST_VIEW_MANAGER_ASYNC_CALL_RESPONSE_${requestId}`, function (event, error, result) {
    287. 

  287.           if (error == null) {
    288. 

  288.             if (callback) {
    289. 

  289.               callback(result)
    290. 

  290.             }
    291. 

  291.             resolve(result)
    292. 

  292.           } else {
    293. 

  293.             reject(errorUtils.deserialize(error))
    294. 

  294.           }
    295. 

  295.         })
    296. 

  296.         ipcRenderer.send('ELECTRON_GUEST_VIEW_MANAGER_ASYNC_CALL', requestId, getGuestInstanceId(this), method, args, callback != null)
    297. 

  297.       })
    298. 

  298.     }
    299. 

  299.   }
    300. 

  300. 

  301.   for (const method of asyncPromiseMethods) {
    302. 

  302.     proto[method] = createPromiseHandler(method)
    303. 

  303.   }
    304. 

  304. 

  305.   // WebContents associated with this webview.
    306. 

  306.   proto.getWebContents = function () {
    307. 

  307.     const { getRemoteForUsage } = require('@electron/internal/renderer/remote')
    308. 

  308.     const remote = getRemoteForUsage('getWebContents()')
    309. 

  309.     const internal = v8Util.getHiddenValue(this, 'internal')
    310. 

  310.     if (!internal.guestInstanceId) {
    311. 

  311.       internal.createGuestSync()
    312. 

  312.     }
    313. 

  313.     return remote.getGuestWebContents(internal.guestInstanceId)
    314. 

  314.   }
    315. 

  315. 

  316.   // Focusing the webview should move page focus to the underlying iframe.
    317. 

  317.   proto.focus = function () {
    318. 

  318.     this.contentWindow.focus()
    319. 

  319.   }
    320. 

  320. 

  321.   window.WebView = webFrame.registerEmbedderCustomElement(window, 'webview', {
    322. 

  322.     prototype: proto
    323. 

  323.   })
    324. 

  324. 

  325.   // Delete the callbacks so developers cannot call them and produce unexpected
    326. 

  326.   // behavior.
    327. 

  327.   delete proto.createdCallback
    328. 

  328.   delete proto.attachedCallback
    329. 

  329.   delete proto.detachedCallback
    330. 

  330.   delete proto.attributeChangedCallback
    331. 

  331. }
    332. 

  332. 

  333. const setupWebView = (window) => {
    334. 

  334.   require('@electron/internal/renderer/web-view/web-view-attributes')
    335. 

  335. 

  336.   const useCapture = true
    337. 

  337.   window.addEventListener('readystatechange', function listener (event) {
    338. 

  338.     if (document.readyState === 'loading') {
    339. 

  339.       return
    340. 

  340.     }
    341. 

  341.     registerWebViewElement(window)
    342. 

  342.     window.removeEventListener(event.type, listener, useCapture)
    343. 

  343.   }, useCapture)
    344. 

  344. }
    345. 

  345. 

  346. module.exports = { setupWebView, WebViewImpl }
    347.