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

chrome-extension.js 12 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394 
  1. const {app, ipcMain, webContents, BrowserWindow} = require('electron')
    2. 

  2. const {getAllWebContents} = process.atomBinding('web_contents')
    3. 

  3. const renderProcessPreferences = process.atomBinding('render_process_preferences').forAllWebContents()
    4. 

  4. 

  5. const {Buffer} = require('buffer')
    6. 

  6. const fs = require('fs')
    7. 

  7. const path = require('path')
    8. 

  8. const url = require('url')
    9. 

  9. 

  10. // TODO(zcbenz): Remove this when we have Object.values().
    11. 

  11. const objectValues = function (object) {
    12. 

  12.   return Object.keys(object).map(function (key) { return object[key] })
    13. 

  13. }
    14. 

  14. 

  15. // Mapping between extensionId(hostname) and manifest.
    16. 

  16. const manifestMap = {}  // extensionId => manifest
    17. 

  17. const manifestNameMap = {}  // name => manifest
    18. 

  18. 

  19. const generateExtensionIdFromName = function (name) {
    20. 

  20.   return name.replace(/[\W_]+/g, '-').toLowerCase()
    21. 

  21. }
    22. 

  22. 

  23. const isWindowOrWebView = function (webContents) {
    24. 

  24.   const type = webContents.getType()
    25. 

  25.   return type === 'window' || type === 'webview'
    26. 

  26. }
    27. 

  27. 

  28. // Create or get manifest object from |srcDirectory|.
    29. 

  29. const getManifestFromPath = function (srcDirectory) {
    30. 

  30.   let manifest
    31. 

  31.   let manifestContent
    32. 

  32. 

  33.   try {
    34. 

  34.     manifestContent = fs.readFileSync(path.join(srcDirectory, 'manifest.json'))
    35. 

  35.   } catch (readError) {
    36. 

  36.     console.warn(`Reading ${path.join(srcDirectory, 'manifest.json')} failed.`)
    37. 

  37.     console.warn(readError.stack || readError)
    38. 

  38.     throw readError
    39. 

  39.   }
    40. 

  40. 

  41.   try {
    42. 

  42.     manifest = JSON.parse(manifestContent)
    43. 

  43.   } catch (parseError) {
    44. 

  44.     console.warn(`Parsing ${path.join(srcDirectory, 'manifest.json')} failed.`)
    45. 

  45.     console.warn(parseError.stack || parseError)
    46. 

  46.     throw parseError
    47. 

  47.   }
    48. 

  48. 

  49.   if (!manifestNameMap[manifest.name]) {
    50. 

  50.     const extensionId = generateExtensionIdFromName(manifest.name)
    51. 

  51.     manifestMap[extensionId] = manifestNameMap[manifest.name] = manifest
    52. 

  52.     Object.assign(manifest, {
    53. 

  53.       srcDirectory: srcDirectory,
    54. 

  54.       extensionId: extensionId,
    55. 

  55.       // We can not use 'file://' directly because all resources in the extension
    56. 

  56.       // will be treated as relative to the root in Chrome.
    57. 

  57.       startPage: url.format({
    58. 

  58.         protocol: 'chrome-extension',
    59. 

  59.         slashes: true,
    60. 

  60.         hostname: extensionId,
    61. 

  61.         pathname: manifest.devtools_page
    62. 

  62.       })
    63. 

  63.     })
    64. 

  64.     return manifest
    65. 

  65.   } else if (manifest && manifest.name) {
    66. 

  66.     console.warn(`Attempted to load extension "${manifest.name}" that has already been loaded.`)
    67. 

  67.   }
    68. 

  68. }
    69. 

  69. 

  70. // Manage the background pages.
    71. 

  71. const backgroundPages = {}
    72. 

  72. 

  73. const startBackgroundPages = function (manifest) {
    74. 

  74.   if (backgroundPages[manifest.extensionId] || !manifest.background) return
    75. 

  75. 

  76.   let html
    77. 

  77.   let name
    78. 

  78.   if (manifest.background.page) {
    79. 

  79.     name = manifest.background.page
    80. 

  80.     html = fs.readFileSync(path.join(manifest.srcDirectory, manifest.background.page))
    81. 

  81.   } else {
    82. 

  82.     name = '_generated_background_page.html'
    83. 

  83.     const scripts = manifest.background.scripts.map((name) => {
    84. 

  84.       return `<script src="${name}"></script>`
    85. 

  85.     }).join('')
    86. 

  86.     html = new Buffer(`<html><body>${scripts}</body></html>`)
    87. 

  87.   }
    88. 

  88. 

  89.   const contents = webContents.create({
    90. 

  90.     partition: 'persist:__chrome_extension',
    91. 

  91.     isBackgroundPage: true,
    92. 

  92.     commandLineSwitches: ['--background-page']
    93. 

  93.   })
    94. 

  94.   backgroundPages[manifest.extensionId] = { html: html, webContents: contents, name: name }
    95. 

  95.   contents.loadURL(url.format({
    96. 

  96.     protocol: 'chrome-extension',
    97. 

  97.     slashes: true,
    98. 

  98.     hostname: manifest.extensionId,
    99. 

  99.     pathname: name
    100. 

  100.   }))
    101. 

  101. }
    102. 

  102. 

  103. const removeBackgroundPages = function (manifest) {
    104. 

  104.   if (!backgroundPages[manifest.extensionId]) return
    105. 

  105. 

  106.   backgroundPages[manifest.extensionId].webContents.destroy()
    107. 

  107.   delete backgroundPages[manifest.extensionId]
    108. 

  108. }
    109. 

  109. 

  110. const sendToBackgroundPages = function (...args) {
    111. 

  111.   for (const page of objectValues(backgroundPages)) {
    112. 

  112.     page.webContents.sendToAll(...args)
    113. 

  113.   }
    114. 

  114. }
    115. 

  115. 

  116. // Dispatch web contents events to Chrome APIs
    117. 

  117. const hookWebContentsEvents = function (webContents) {
    118. 

  118.   const tabId = webContents.id
    119. 

  119. 

  120.   sendToBackgroundPages('CHROME_TABS_ONCREATED')
    121. 

  121. 

  122.   webContents.on('will-navigate', (event, url) => {
    123. 

  123.     sendToBackgroundPages('CHROME_WEBNAVIGATION_ONBEFORENAVIGATE', {
    124. 

  124.       frameId: 0,
    125. 

  125.       parentFrameId: -1,
    126. 

  126.       processId: webContents.getId(),
    127. 

  127.       tabId: tabId,
    128. 

  128.       timeStamp: Date.now(),
    129. 

  129.       url: url
    130. 

  130.     })
    131. 

  131.   })
    132. 

  132. 

  133.   webContents.on('did-navigate', (event, url) => {
    134. 

  134.     sendToBackgroundPages('CHROME_WEBNAVIGATION_ONCOMPLETED', {
    135. 

  135.       frameId: 0,
    136. 

  136.       parentFrameId: -1,
    137. 

  137.       processId: webContents.getId(),
    138. 

  138.       tabId: tabId,
    139. 

  139.       timeStamp: Date.now(),
    140. 

  140.       url: url
    141. 

  141.     })
    142. 

  142.   })
    143. 

  143. 

  144.   webContents.once('destroyed', () => {
    145. 

  145.     sendToBackgroundPages('CHROME_TABS_ONREMOVED', tabId)
    146. 

  146.   })
    147. 

  147. }
    148. 

  148. 

  149. // Handle the chrome.* API messages.
    150. 

  150. let nextId = 0
    151. 

  151. 

  152. ipcMain.on('CHROME_RUNTIME_CONNECT', function (event, extensionId, connectInfo) {
    153. 

  153.   const page = backgroundPages[extensionId]
    154. 

  154.   if (!page) {
    155. 

  155.     console.error(`Connect to unknown extension ${extensionId}`)
    156. 

  156.     return
    157. 

  157.   }
    158. 

  158. 

  159.   const portId = ++nextId
    160. 

  160.   event.returnValue = {tabId: page.webContents.id, portId: portId}
    161. 

  161. 

  162.   event.sender.once('render-view-deleted', () => {
    163. 

  163.     if (page.webContents.isDestroyed()) return
    164. 

  164.     page.webContents.sendToAll(`CHROME_PORT_DISCONNECT_${portId}`)
    165. 

  165.   })
    166. 

  166.   page.webContents.sendToAll(`CHROME_RUNTIME_ONCONNECT_${extensionId}`, event.sender.id, portId, connectInfo)
    167. 

  167. })
    168. 

  168. 

  169. ipcMain.on('CHROME_I18N_MANIFEST', function (event, extensionId) {
    170. 

  170.   event.returnValue = manifestMap[extensionId]
    171. 

  171. })
    172. 

  172. 

  173. ipcMain.on('CHROME_RUNTIME_SENDMESSAGE', function (event, extensionId, message) {
    174. 

  174.   const page = backgroundPages[extensionId]
    175. 

  175.   if (!page) {
    176. 

  176.     console.error(`Connect to unknown extension ${extensionId}`)
    177. 

  177.     return
    178. 

  178.   }
    179. 

  179. 

  180.   page.webContents.sendToAll(`CHROME_RUNTIME_ONMESSAGE_${extensionId}`, event.sender.id, message)
    181. 

  181. })
    182. 

  182. 

  183. ipcMain.on('CHROME_TABS_SEND_MESSAGE', function (event, tabId, extensionId, isBackgroundPage, message) {
    184. 

  184.   const contents = webContents.fromId(tabId)
    185. 

  185.   if (!contents) {
    186. 

  186.     console.error(`Sending message to unknown tab ${tabId}`)
    187. 

  187.     return
    188. 

  188.   }
    189. 

  189. 

  190.   const senderTabId = isBackgroundPage ? null : event.sender.id
    191. 

  191. 

  192.   contents.sendToAll(`CHROME_RUNTIME_ONMESSAGE_${extensionId}`, senderTabId, message)
    193. 

  193. })
    194. 

  194. 

  195. ipcMain.on('CHROME_TABS_EXECUTESCRIPT', function (event, requestId, tabId, extensionId, details) {
    196. 

  196.   const contents = webContents.fromId(tabId)
    197. 

  197.   if (!contents) {
    198. 

  198.     console.error(`Sending message to unknown tab ${tabId}`)
    199. 

  199.     return
    200. 

  200.   }
    201. 

  201. 

  202.   let code, url
    203. 

  203.   if (details.file) {
    204. 

  204.     const manifest = manifestMap[extensionId]
    205. 

  205.     code = String(fs.readFileSync(path.join(manifest.srcDirectory, details.file)))
    206. 

  206.     url = `chrome-extension://${extensionId}${details.file}`
    207. 

  207.   } else {
    208. 

  208.     code = details.code
    209. 

  209.     url = `chrome-extension://${extensionId}/${String(Math.random()).substr(2, 8)}.js`
    210. 

  210.   }
    211. 

  211. 

  212.   contents.send('CHROME_TABS_EXECUTESCRIPT', event.sender.id, requestId, extensionId, url, code)
    213. 

  213. })
    214. 

  214. 

  215. // Transfer the content scripts to renderer.
    216. 

  216. const contentScripts = {}
    217. 

  217. 

  218. const injectContentScripts = function (manifest) {
    219. 

  219.   if (contentScripts[manifest.name] || !manifest.content_scripts) return
    220. 

  220. 

  221.   const readArrayOfFiles = function (relativePath) {
    222. 

  222.     return {
    223. 

  223.       url: `chrome-extension://${manifest.extensionId}/${relativePath}`,
    224. 

  224.       code: String(fs.readFileSync(path.join(manifest.srcDirectory, relativePath)))
    225. 

  225.     }
    226. 

  226.   }
    227. 

  227. 

  228.   const contentScriptToEntry = function (script) {
    229. 

  229.     return {
    230. 

  230.       matches: script.matches,
    231. 

  231.       js: script.js.map(readArrayOfFiles),
    232. 

  232.       runAt: script.run_at || 'document_idle'
    233. 

  233.     }
    234. 

  234.   }
    235. 

  235. 

  236.   try {
    237. 

  237.     const entry = {
    238. 

  238.       extensionId: manifest.extensionId,
    239. 

  239.       contentScripts: manifest.content_scripts.map(contentScriptToEntry)
    240. 

  240.     }
    241. 

  241.     contentScripts[manifest.name] = renderProcessPreferences.addEntry(entry)
    242. 

  242.   } catch (e) {
    243. 

  243.     console.error('Failed to read content scripts', e)
    244. 

  244.   }
    245. 

  245. }
    246. 

  246. 

  247. const removeContentScripts = function (manifest) {
    248. 

  248.   if (!contentScripts[manifest.name]) return
    249. 

  249. 

  250.   renderProcessPreferences.removeEntry(contentScripts[manifest.name])
    251. 

  251.   delete contentScripts[manifest.name]
    252. 

  252. }
    253. 

  253. 

  254. // Transfer the |manifest| to a format that can be recognized by the
    255. 

  255. // |DevToolsAPI.addExtensions|.
    256. 

  256. const manifestToExtensionInfo = function (manifest) {
    257. 

  257.   return {
    258. 

  258.     startPage: manifest.startPage,
    259. 

  259.     srcDirectory: manifest.srcDirectory,
    260. 

  260.     name: manifest.name,
    261. 

  261.     exposeExperimentalAPIs: true
    262. 

  262.   }
    263. 

  263. }
    264. 

  264. 

  265. // Load the extensions for the window.
    266. 

  266. const loadExtension = function (manifest) {
    267. 

  267.   startBackgroundPages(manifest)
    268. 

  268.   injectContentScripts(manifest)
    269. 

  269. }
    270. 

  270. 

  271. const loadDevToolsExtensions = function (win, manifests) {
    272. 

  272.   if (!win.devToolsWebContents) return
    273. 

  273. 

  274.   manifests.forEach(loadExtension)
    275. 

  275. 

  276.   const extensionInfoArray = manifests.map(manifestToExtensionInfo)
    277. 

  277.   win.devToolsWebContents.executeJavaScript(`DevToolsAPI.addExtensions(${JSON.stringify(extensionInfoArray)})`)
    278. 

  278. }
    279. 

  279. 

  280. app.on('web-contents-created', function (event, webContents) {
    281. 

  281.   if (!isWindowOrWebView(webContents)) return
    282. 

  282. 

  283.   hookWebContentsEvents(webContents)
    284. 

  284.   webContents.on('devtools-opened', function () {
    285. 

  285.     loadDevToolsExtensions(webContents, objectValues(manifestMap))
    286. 

  286.   })
    287. 

  287. })
    288. 

  288. 

  289. // The chrome-extension: can map a extension URL request to real file path.
    290. 

  290. const chromeExtensionHandler = function (request, callback) {
    291. 

  291.   const parsed = url.parse(request.url)
    292. 

  292.   if (!parsed.hostname || !parsed.path) return callback()
    293. 

  293. 

  294.   const manifest = manifestMap[parsed.hostname]
    295. 

  295.   if (!manifest) return callback()
    296. 

  296. 

  297.   const page = backgroundPages[parsed.hostname]
    298. 

  298.   if (page && parsed.path === `/${page.name}`) {
    299. 

  299.     return callback({
    300. 

  300.       mimeType: 'text/html',
    301. 

  301.       data: page.html
    302. 

  302.     })
    303. 

  303.   }
    304. 

  304. 

  305.   fs.readFile(path.join(manifest.srcDirectory, parsed.path), function (err, content) {
    306. 

  306.     if (err) {
    307. 

  307.       return callback(-6)  // FILE_NOT_FOUND
    308. 

  308.     } else {
    309. 

  309.       return callback(content)
    310. 

  310.     }
    311. 

  311.   })
    312. 

  312. }
    313. 

  313. 

  314. app.on('session-created', function (ses) {
    315. 

  315.   ses.protocol.registerBufferProtocol('chrome-extension', chromeExtensionHandler, function (error) {
    316. 

  316.     if (error) {
    317. 

  317.       console.error(`Unable to register chrome-extension protocol: ${error}`)
    318. 

  318.     }
    319. 

  319.   })
    320. 

  320. })
    321. 

  321. 

  322. // The persistent path of "DevTools Extensions" preference file.
    323. 

  323. let loadedExtensionsPath = null
    324. 

  324. 

  325. app.on('will-quit', function () {
    326. 

  326.   try {
    327. 

  327.     const loadedExtensions = objectValues(manifestMap).map(function (manifest) {
    328. 

  328.       return manifest.srcDirectory
    329. 

  329.     })
    330. 

  330.     if (loadedExtensions.length > 0) {
    331. 

  331.       try {
    332. 

  332.         fs.mkdirSync(path.dirname(loadedExtensionsPath))
    333. 

  333.       } catch (error) {
    334. 

  334.         // Ignore error
    335. 

  335.       }
    336. 

  336.       fs.writeFileSync(loadedExtensionsPath, JSON.stringify(loadedExtensions))
    337. 

  337.     } else {
    338. 

  338.       fs.unlinkSync(loadedExtensionsPath)
    339. 

  339.     }
    340. 

  340.   } catch (error) {
    341. 

  341.     // Ignore error
    342. 

  342.   }
    343. 

  343. })
    344. 

  344. 

  345. // We can not use protocol or BrowserWindow until app is ready.
    346. 

  346. app.once('ready', function () {
    347. 

  347.   // Load persisted extensions.
    348. 

  348.   loadedExtensionsPath = path.join(app.getPath('userData'), 'DevTools Extensions')
    349. 

  349.   try {
    350. 

  350.     const loadedExtensions = JSON.parse(fs.readFileSync(loadedExtensionsPath))
    351. 

  351.     if (Array.isArray(loadedExtensions)) {
    352. 

  352.       for (const srcDirectory of loadedExtensions) {
    353. 

  353.         // Start background pages and set content scripts.
    354. 

  354.         const manifest = getManifestFromPath(srcDirectory)
    355. 

  355.         loadExtension(manifest)
    356. 

  356.       }
    357. 

  357.     }
    358. 

  358.   } catch (error) {
    359. 

  359.     // Ignore error
    360. 

  360.   }
    361. 

  361. 

  362.   // The public API to add/remove extensions.
    363. 

  363.   BrowserWindow.addDevToolsExtension = function (srcDirectory) {
    364. 

  364.     const manifest = getManifestFromPath(srcDirectory)
    365. 

  365.     if (manifest) {
    366. 

  366.       loadExtension(manifest)
    367. 

  367.       for (const webContents of getAllWebContents()) {
    368. 

  368.         if (isWindowOrWebView(webContents)) {
    369. 

  369.           loadDevToolsExtensions(webContents, [manifest])
    370. 

  370.         }
    371. 

  371.       }
    372. 

  372.       return manifest.name
    373. 

  373.     }
    374. 

  374.   }
    375. 

  375. 

  376.   BrowserWindow.removeDevToolsExtension = function (name) {
    377. 

  377.     const manifest = manifestNameMap[name]
    378. 

  378.     if (!manifest) return
    379. 

  379. 

  380.     removeBackgroundPages(manifest)
    381. 

  381.     removeContentScripts(manifest)
    382. 

  382.     delete manifestMap[manifest.extensionId]
    383. 

  383.     delete manifestNameMap[name]
    384. 

  384.   }
    385. 

  385. 

  386.   BrowserWindow.getDevToolsExtensions = function () {
    387. 

  387.     const extensions = {}
    388. 

  388.     Object.keys(manifestNameMap).forEach(function (name) {
    389. 

  389.       const manifest = manifestNameMap[name]
    390. 

  390.       extensions[name] = {name: manifest.name, version: manifest.version}
    391. 

  391.     })
    392. 

  392.     return extensions
    393. 

  393.   }
    394. 

  394. })
    395.