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

web-view.js 12 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400 
  1. 'use strict'
    2. 

  2. 

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

  4. 

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

  6. const guestViewInternal = require('./guest-view-internal')
    7. 

  7. const webViewConstants = require('./web-view-constants')
    8. 

  8. 

  9. // An unique ID that can represent current context.
    10. 

  10. const contextId = v8Util.getHiddenValue(global, 'contextId')
    11. 

  11. 

  12. // ID generator.
    13. 

  13. let nextId = 0
    14. 

  14. 

  15. const getNextId = function () {
    16. 

  16.   return ++nextId
    17. 

  17. }
    18. 

  18. 

  19. // A list of removed attributes from 3.0.
    20. 

  20. const removedAttributes = [
    21. 

  21.   'autoresize',
    22. 

  22.   'disableguestresize',
    23. 

  23.   'guestinstance'
    24. 

  24. ]
    25. 

  25. 

  26. // Represents the internal state of the WebView node.
    27. 

  27. class WebViewImpl {
    28. 

  28.   constructor (webviewNode) {
    29. 

  29.     this.webviewNode = webviewNode
    30. 

  30.     v8Util.setHiddenValue(this.webviewNode, 'internal', this)
    31. 

  31.     this.elementAttached = false
    32. 

  32.     this.beforeFirstNavigation = true
    33. 

  33.     this.hasFocus = false
    34. 

  34. 

  35.     // Check for removed attributes.
    36. 

  36.     for (const attributeName of removedAttributes) {
    37. 

  37.       if (this.webviewNode.hasAttribute(attributeName)) {
    38. 

  38.         this.reportRemovedAttribute(attributeName)
    39. 

  39.       }
    40. 

  40.     }
    41. 

  41. 

  42.     // on* Event handlers.
    43. 

  43.     this.on = {}
    44. 

  44. 

  45.     // Create internal iframe element.
    46. 

  46.     this.internalElement = this.createInternalElement()
    47. 

  47.     const shadowRoot = this.webviewNode.attachShadow({mode: 'open'})
    48. 

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

  49.     this.setupWebViewAttributes()
    50. 

  50.     this.viewInstanceId = getNextId()
    51. 

  51.     shadowRoot.appendChild(this.internalElement)
    52. 

  52. 

  53.     // Provide access to contentWindow.
    54. 

  54.     Object.defineProperty(this.webviewNode, 'contentWindow', {
    55. 

  55.       get: () => {
    56. 

  56.         return this.internalElement.contentWindow
    57. 

  57.       },
    58. 

  58.       enumerable: true
    59. 

  59.     })
    60. 

  60.   }
    61. 

  61. 

  62.   createInternalElement () {
    63. 

  63.     const iframeElement = document.createElement('iframe')
    64. 

  64.     iframeElement.style.flex = '1 1 auto'
    65. 

  65.     iframeElement.style.width = '100%'
    66. 

  66.     iframeElement.style.border = '0'
    67. 

  67.     v8Util.setHiddenValue(iframeElement, 'internal', this)
    68. 

  68.     return iframeElement
    69. 

  69.   }
    70. 

  70. 

  71.   // Resets some state upon reattaching <webview> element to the DOM.
    72. 

  72.   reset () {
    73. 

  73.     // If guestInstanceId is defined then the <webview> has navigated and has
    74. 

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

  75.     // state. However, it may be the case that beforeFirstNavigation is false BUT
    76. 

  76.     // guestInstanceId has yet to be initialized. This means that we have not
    77. 

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

  78.     // that we don't end up allocating a second guest.
    79. 

  79.     if (this.guestInstanceId) {
    80. 

  80.       guestViewInternal.destroyGuest(this.guestInstanceId)
    81. 

  81.       this.guestInstanceId = void 0
    82. 

  82.     }
    83. 

  83. 

  84.     this.webContents = null
    85. 

  85.     this.beforeFirstNavigation = true
    86. 

  86.     this.attributes[webViewConstants.ATTRIBUTE_PARTITION].validPartitionId = true
    87. 

  87. 

  88.     // Since attachment swaps a local frame for a remote frame, we need our
    89. 

  89.     // internal iframe element to be local again before we can reattach.
    90. 

  90.     const newFrame = this.createInternalElement()
    91. 

  91.     const oldFrame = this.internalElement
    92. 

  92.     this.internalElement = newFrame
    93. 

  93.     oldFrame.parentNode.replaceChild(newFrame, oldFrame)
    94. 

  94.   }
    95. 

  95. 

  96.   // Sets the <webview>.request property.
    97. 

  97.   setRequestPropertyOnWebViewNode (request) {
    98. 

  98.     Object.defineProperty(this.webviewNode, 'request', {
    99. 

  99.       value: request,
    100. 

  100.       enumerable: true
    101. 

  101.     })
    102. 

  102.   }
    103. 

  103. 

  104.   // This observer monitors mutations to attributes of the <webview> and
    105. 

  105.   // updates the BrowserPlugin properties accordingly. In turn, updating
    106. 

  106.   // a BrowserPlugin property will update the corresponding BrowserPlugin
    107. 

  107.   // attribute, if necessary. See BrowserPlugin::UpdateDOMAttribute for more
    108. 

  108.   // details.
    109. 

  109.   handleWebviewAttributeMutation (attributeName, oldValue, newValue) {
    110. 

  110.     if (removedAttributes.includes(attributeName)) {
    111. 

  111.       this.reportRemovedAttribute(attributeName)
    112. 

  112.       return
    113. 

  113.     }
    114. 

  114. 

  115.     if (!this.attributes[attributeName] || this.attributes[attributeName].ignoreMutation) {
    116. 

  116.       return
    117. 

  117.     }
    118. 

  118. 

  119.     // Let the changed attribute handle its own mutation
    120. 

  120.     this.attributes[attributeName].handleMutation(oldValue, newValue)
    121. 

  121.   }
    122. 

  122. 

  123.   onElementResize () {
    124. 

  124.     const resizeEvent = new Event('resize', { bubbles: true })
    125. 

  125.     resizeEvent.newWidth = this.webviewNode.clientWidth
    126. 

  126.     resizeEvent.newHeight = this.webviewNode.clientHeight
    127. 

  127.     this.dispatchEvent(resizeEvent)
    128. 

  128.   }
    129. 

  129. 

  130.   createGuest () {
    131. 

  131.     return guestViewInternal.createGuest(this.buildParams(), (event, guestInstanceId) => {
    132. 

  132.       this.attachGuestInstance(guestInstanceId)
    133. 

  133.     })
    134. 

  134.   }
    135. 

  135. 

  136.   createGuestSync () {
    137. 

  137.     this.beforeFirstNavigation = false
    138. 

  138.     this.attachGuestInstance(guestViewInternal.createGuestSync(this.buildParams()))
    139. 

  139.   }
    140. 

  140. 

  141.   dispatchEvent (webViewEvent) {
    142. 

  142.     this.webviewNode.dispatchEvent(webViewEvent)
    143. 

  143.   }
    144. 

  144. 

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

  146.   // an event handler.
    147. 

  147.   setupEventProperty (eventName) {
    148. 

  148.     const propertyName = `on${eventName.toLowerCase()}`
    149. 

  149.     return Object.defineProperty(this.webviewNode, propertyName, {
    150. 

  150.       get: () => {
    151. 

  151.         return this.on[propertyName]
    152. 

  152.       },
    153. 

  153.       set: (value) => {
    154. 

  154.         if (this.on[propertyName]) {
    155. 

  155.           this.webviewNode.removeEventListener(eventName, this.on[propertyName])
    156. 

  156.         }
    157. 

  157.         this.on[propertyName] = value
    158. 

  158.         if (value) {
    159. 

  159.           return this.webviewNode.addEventListener(eventName, value)
    160. 

  160.         }
    161. 

  161.       },
    162. 

  162.       enumerable: true
    163. 

  163.     })
    164. 

  164.   }
    165. 

  165. 

  166.   // Updates state upon loadcommit.
    167. 

  167.   onLoadCommit (webViewEvent) {
    168. 

  168.     const oldValue = this.webviewNode.getAttribute(webViewConstants.ATTRIBUTE_SRC)
    169. 

  169.     const newValue = webViewEvent.url
    170. 

  170.     if (webViewEvent.isMainFrame && (oldValue !== newValue)) {
    171. 

  171.       // Touching the src attribute triggers a navigation. To avoid
    172. 

  172.       // triggering a page reload on every guest-initiated navigation,
    173. 

  173.       // we do not handle this mutation.
    174. 

  174.       this.attributes[webViewConstants.ATTRIBUTE_SRC].setValueIgnoreMutation(newValue)
    175. 

  175.     }
    176. 

  176.   }
    177. 

  177. 

  178.   // Emits focus/blur events.
    179. 

  179.   onFocusChange () {
    180. 

  180.     const hasFocus = document.activeElement === this.webviewNode
    181. 

  181.     if (hasFocus !== this.hasFocus) {
    182. 

  182.       this.hasFocus = hasFocus
    183. 

  183.       this.dispatchEvent(new Event(hasFocus ? 'focus' : 'blur'))
    184. 

  184.     }
    185. 

  185.   }
    186. 

  186. 

  187.   onAttach (storagePartitionId) {
    188. 

  188.     return this.attributes[webViewConstants.ATTRIBUTE_PARTITION].setValue(storagePartitionId)
    189. 

  189.   }
    190. 

  190. 

  191.   buildParams () {
    192. 

  192.     const params = {
    193. 

  193.       instanceId: this.viewInstanceId,
    194. 

  194.       userAgentOverride: this.userAgentOverride
    195. 

  195.     }
    196. 

  196.     for (const attributeName in this.attributes) {
    197. 

  197.       if (this.attributes.hasOwnProperty(attributeName)) {
    198. 

  198.         params[attributeName] = this.attributes[attributeName].getValue()
    199. 

  199.       }
    200. 

  200.     }
    201. 

  201.     return params
    202. 

  202.   }
    203. 

  203. 

  204.   attachGuestInstance (guestInstanceId) {
    205. 

  205.     if (!this.elementAttached) {
    206. 

  206.       // The element could be detached before we got response from browser.
    207. 

  207.       return
    208. 

  208.     }
    209. 

  209.     this.internalInstanceId = getNextId()
    210. 

  210.     this.guestInstanceId = guestInstanceId
    211. 

  211.     this.webContents = remote.getGuestWebContents(this.guestInstanceId)
    212. 

  212.     guestViewInternal.attachGuest(this.internalInstanceId, this.guestInstanceId, this.buildParams(), this.internalElement.contentWindow)
    213. 

  213.     // ResizeObserver is a browser global not recognized by "standard".
    214. 

  214.     /* globals ResizeObserver */
    215. 

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

  216.     // even documented.
    217. 

  217.     this.resizeObserver = new ResizeObserver(this.onElementResize.bind(this)).observe(this.internalElement)
    218. 

  218.   }
    219. 

  219. 

  220.   // TODO(zcbenz): Remove the warning in 4.0.
    221. 

  221.   reportRemovedAttribute (attributeName) {
    222. 

  222.     console.error(`The "${attributeName}" attribute has been removed from the <webview> tag,`,
    223. 

  223.                   'see https://github.com/electron/electron/issues/14120 for more.')
    224. 

  224.   }
    225. 

  225. }
    226. 

  226. 

  227. // Registers <webview> custom element.
    228. 

  228. const registerWebViewElement = function () {
    229. 

  229.   const proto = Object.create(HTMLObjectElement.prototype)
    230. 

  230.   proto.createdCallback = function () {
    231. 

  231.     return new WebViewImpl(this)
    232. 

  232.   }
    233. 

  233.   proto.attributeChangedCallback = function (name, oldValue, newValue) {
    234. 

  234.     const internal = v8Util.getHiddenValue(this, 'internal')
    235. 

  235.     if (internal) {
    236. 

  236.       internal.handleWebviewAttributeMutation(name, oldValue, newValue)
    237. 

  237.     }
    238. 

  238.   }
    239. 

  239.   proto.detachedCallback = function () {
    240. 

  240.     const internal = v8Util.getHiddenValue(this, 'internal')
    241. 

  241.     if (!internal) {
    242. 

  242.       return
    243. 

  243.     }
    244. 

  244.     guestViewInternal.deregisterEvents(internal.viewInstanceId)
    245. 

  245.     internal.elementAttached = false
    246. 

  246.     this.internalInstanceId = 0
    247. 

  247.     internal.reset()
    248. 

  248.   }
    249. 

  249.   proto.attachedCallback = function () {
    250. 

  250.     const internal = v8Util.getHiddenValue(this, 'internal')
    251. 

  251.     if (!internal) {
    252. 

  252.       return
    253. 

  253.     }
    254. 

  254.     if (!internal.elementAttached) {
    255. 

  255.       guestViewInternal.registerEvents(internal, internal.viewInstanceId)
    256. 

  256.       internal.elementAttached = true
    257. 

  257.       internal.attributes[webViewConstants.ATTRIBUTE_SRC].parse()
    258. 

  258.     }
    259. 

  259.   }
    260. 

  260. 

  261.   // Public-facing API methods.
    262. 

  262.   const methods = [
    263. 

  263.     'getURL',
    264. 

  264.     'loadURL',
    265. 

  265.     'getTitle',
    266. 

  266.     'isLoading',
    267. 

  267.     'isLoadingMainFrame',
    268. 

  268.     'isWaitingForResponse',
    269. 

  269.     'stop',
    270. 

  270.     'reload',
    271. 

  271.     'reloadIgnoringCache',
    272. 

  272.     'canGoBack',
    273. 

  273.     'canGoForward',
    274. 

  274.     'canGoToOffset',
    275. 

  275.     'clearHistory',
    276. 

  276.     'goBack',
    277. 

  277.     'goForward',
    278. 

  278.     'goToIndex',
    279. 

  279.     'goToOffset',
    280. 

  280.     'isCrashed',
    281. 

  281.     'setUserAgent',
    282. 

  282.     'getUserAgent',
    283. 

  283.     'openDevTools',
    284. 

  284.     'closeDevTools',
    285. 

  285.     'isDevToolsOpened',
    286. 

  286.     'isDevToolsFocused',
    287. 

  287.     'inspectElement',
    288. 

  288.     'setAudioMuted',
    289. 

  289.     'isAudioMuted',
    290. 

  290.     'undo',
    291. 

  291.     'redo',
    292. 

  292.     'cut',
    293. 

  293.     'copy',
    294. 

  294.     'paste',
    295. 

  295.     'pasteAndMatchStyle',
    296. 

  296.     'delete',
    297. 

  297.     'selectAll',
    298. 

  298.     'unselect',
    299. 

  299.     'replace',
    300. 

  300.     'replaceMisspelling',
    301. 

  301.     'findInPage',
    302. 

  302.     'stopFindInPage',
    303. 

  303.     'getId',
    304. 

  304.     'downloadURL',
    305. 

  305.     'inspectServiceWorker',
    306. 

  306.     'print',
    307. 

  307.     'printToPDF',
    308. 

  308.     'showDefinitionForSelection',
    309. 

  309.     'capturePage',
    310. 

  310.     'setZoomFactor',
    311. 

  311.     'setZoomLevel',
    312. 

  312.     'getZoomLevel',
    313. 

  313.     'getZoomFactor'
    314. 

  314.   ]
    315. 

  315.   const nonblockMethods = [
    316. 

  316.     'insertCSS',
    317. 

  317.     'insertText',
    318. 

  318.     'send',
    319. 

  319.     'sendInputEvent',
    320. 

  320.     'setLayoutZoomLevelLimits',
    321. 

  321.     'setVisualZoomLevelLimits'
    322. 

  322.   ]
    323. 

  323. 

  324.   // Forward proto.foo* method calls to WebViewImpl.foo*.
    325. 

  325.   const createBlockHandler = function (m) {
    326. 

  326.     return function (...args) {
    327. 

  327.       const internal = v8Util.getHiddenValue(this, 'internal')
    328. 

  328.       if (internal.webContents) {
    329. 

  329.         return internal.webContents[m](...args)
    330. 

  330.       } else {
    331. 

  331.         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.`)
    332. 

  332.       }
    333. 

  333.     }
    334. 

  334.   }
    335. 

  335.   for (const method of methods) {
    336. 

  336.     proto[method] = createBlockHandler(method)
    337. 

  337.   }
    338. 

  338. 

  339.   const createNonBlockHandler = function (m) {
    340. 

  340.     return function (...args) {
    341. 

  341.       const internal = v8Util.getHiddenValue(this, 'internal')
    342. 

  342.       ipcRenderer.send('ELECTRON_BROWSER_ASYNC_CALL_TO_GUEST_VIEW', contextId, null, internal.guestInstanceId, m, ...args)
    343. 

  343.     }
    344. 

  344.   }
    345. 

  345.   for (const method of nonblockMethods) {
    346. 

  346.     proto[method] = createNonBlockHandler(method)
    347. 

  347.   }
    348. 

  348. 

  349.   proto.executeJavaScript = function (code, hasUserGesture, callback) {
    350. 

  350.     const internal = v8Util.getHiddenValue(this, 'internal')
    351. 

  351.     if (typeof hasUserGesture === 'function') {
    352. 

  352.       callback = hasUserGesture
    353. 

  353.       hasUserGesture = false
    354. 

  354.     }
    355. 

  355.     const requestId = getNextId()
    356. 

  356.     ipcRenderer.send('ELECTRON_BROWSER_ASYNC_CALL_TO_GUEST_VIEW', contextId, requestId, internal.guestInstanceId, 'executeJavaScript', code, hasUserGesture)
    357. 

  357.     ipcRenderer.once(`ELECTRON_RENDERER_ASYNC_CALL_TO_GUEST_VIEW_RESPONSE_${requestId}`, function (event, result) {
    358. 

  358.       if (callback) callback(result)
    359. 

  359.     })
    360. 

  360.   }
    361. 

  361. 

  362.   // WebContents associated with this webview.
    363. 

  363.   proto.getWebContents = function () {
    364. 

  364.     const internal = v8Util.getHiddenValue(this, 'internal')
    365. 

  365.     if (!internal.webContents) {
    366. 

  366.       internal.createGuestSync()
    367. 

  367.     }
    368. 

  368.     return internal.webContents
    369. 

  369.   }
    370. 

  370. 

  371.   // Focusing the webview should move page focus to the underlying iframe.
    372. 

  372.   proto.focus = function () {
    373. 

  373.     this.contentWindow.focus()
    374. 

  374.   }
    375. 

  375. 

  376.   window.WebView = webFrame.registerEmbedderCustomElement('webview', {
    377. 

  377.     prototype: proto
    378. 

  378.   })
    379. 

  379. 

  380.   // Delete the callbacks so developers cannot call them and produce unexpected
    381. 

  381.   // behavior.
    382. 

  382.   delete proto.createdCallback
    383. 

  383.   delete proto.attachedCallback
    384. 

  384.   delete proto.detachedCallback
    385. 

  385.   delete proto.attributeChangedCallback
    386. 

  386. }
    387. 

  387. 

  388. const useCapture = true
    389. 

  389. 

  390. const listener = function (event) {
    391. 

  391.   if (document.readyState === 'loading') {
    392. 

  392.     return
    393. 

  393.   }
    394. 

  394.   registerWebViewElement()
    395. 

  395.   window.removeEventListener(event.type, listener, useCapture)
    396. 

  396. }
    397. 

  397. 

  398. window.addEventListener('readystatechange', listener, true)
    399. 

  399. 

  400. module.exports = WebViewImpl
    401.