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

chrome-extension.js 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426 
  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. const devToolsExtensionNames = new Set()
    19. 

  19. 

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

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

  22. }
    23. 

  23. 

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

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

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

  27. }
    28. 

  28. 

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

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

  31.   let manifest
    32. 

  32.   let manifestContent
    33. 

  33. 

  34.   try {
    35. 

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

  36.   } catch (readError) {
    37. 

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

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

  39.     throw readError
    40. 

  40.   }
    41. 

  41. 

  42.   try {
    43. 

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

  44.   } catch (parseError) {
    45. 

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

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

  47.     throw parseError
    48. 

  48.   }
    49. 

  49. 

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

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

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

  53.     Object.assign(manifest, {
    54. 

  54.       srcDirectory: srcDirectory,
    55. 

  55.       extensionId: extensionId,
    56. 

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

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

  58.       startPage: url.format({
    59. 

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

  60.         slashes: true,
    61. 

  61.         hostname: extensionId,
    62. 

  62.         pathname: manifest.devtools_page
    63. 

  63.       })
    64. 

  64.     })
    65. 

  65.     return manifest
    66. 

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

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

  68.     return manifest
    69. 

  69.   }
    70. 

  70. }
    71. 

  71. 

  72. // Manage the background pages.
    73. 

  73. const backgroundPages = {}
    74. 

  74. 

  75. const startBackgroundPages = function (manifest) {
    76. 

  76.   if (backgroundPages[manifest.extensionId] || !manifest.background) return
    77. 

  77. 

  78.   let html
    79. 

  79.   let name
    80. 

  80.   if (manifest.background.page) {
    81. 

  81.     name = manifest.background.page
    82. 

  82.     html = fs.readFileSync(path.join(manifest.srcDirectory, manifest.background.page))
    83. 

  83.   } else {
    84. 

  84.     name = '_generated_background_page.html'
    85. 

  85.     const scripts = manifest.background.scripts.map((name) => {
    86. 

  86.       return `<script src="${name}"></script>`
    87. 

  87.     }).join('')
    88. 

  88.     html = Buffer.from(`<html><body>${scripts}</body></html>`)
    89. 

  89.   }
    90. 

  90. 

  91.   const contents = webContents.create({
    92. 

  92.     partition: 'persist:__chrome_extension',
    93. 

  93.     isBackgroundPage: true,
    94. 

  94.     commandLineSwitches: ['--background-page']
    95. 

  95.   })
    96. 

  96.   backgroundPages[manifest.extensionId] = { html: html, webContents: contents, name: name }
    97. 

  97.   contents.loadURL(url.format({
    98. 

  98.     protocol: 'chrome-extension',
    99. 

  99.     slashes: true,
    100. 

  100.     hostname: manifest.extensionId,
    101. 

  101.     pathname: name
    102. 

  102.   }))
    103. 

  103. }
    104. 

  104. 

  105. const removeBackgroundPages = function (manifest) {
    106. 

  106.   if (!backgroundPages[manifest.extensionId]) return
    107. 

  107. 

  108.   backgroundPages[manifest.extensionId].webContents.destroy()
    109. 

  109.   delete backgroundPages[manifest.extensionId]
    110. 

  110. }
    111. 

  111. 

  112. const sendToBackgroundPages = function (...args) {
    113. 

  113.   for (const page of objectValues(backgroundPages)) {
    114. 

  114.     page.webContents.sendToAll(...args)
    115. 

  115.   }
    116. 

  116. }
    117. 

  117. 

  118. // Dispatch web contents events to Chrome APIs
    119. 

  119. const hookWebContentsEvents = function (webContents) {
    120. 

  120.   const tabId = webContents.id
    121. 

  121. 

  122.   sendToBackgroundPages('CHROME_TABS_ONCREATED')
    123. 

  123. 

  124.   webContents.on('will-navigate', (event, url) => {
    125. 

  125.     sendToBackgroundPages('CHROME_WEBNAVIGATION_ONBEFORENAVIGATE', {
    126. 

  126.       frameId: 0,
    127. 

  127.       parentFrameId: -1,
    128. 

  128.       processId: webContents.getProcessId(),
    129. 

  129.       tabId: tabId,
    130. 

  130.       timeStamp: Date.now(),
    131. 

  131.       url: url
    132. 

  132.     })
    133. 

  133.   })
    134. 

  134. 

  135.   webContents.on('did-navigate', (event, url) => {
    136. 

  136.     sendToBackgroundPages('CHROME_WEBNAVIGATION_ONCOMPLETED', {
    137. 

  137.       frameId: 0,
    138. 

  138.       parentFrameId: -1,
    139. 

  139.       processId: webContents.getProcessId(),
    140. 

  140.       tabId: tabId,
    141. 

  141.       timeStamp: Date.now(),
    142. 

  142.       url: url
    143. 

  143.     })
    144. 

  144.   })
    145. 

  145. 

  146.   webContents.once('destroyed', () => {
    147. 

  147.     sendToBackgroundPages('CHROME_TABS_ONREMOVED', tabId)
    148. 

  148.   })
    149. 

  149. }
    150. 

  150. 

  151. // Handle the chrome.* API messages.
    152. 

  152. let nextId = 0
    153. 

  153. 

  154. ipcMain.on('CHROME_RUNTIME_CONNECT', function (event, extensionId, connectInfo) {
    155. 

  155.   const page = backgroundPages[extensionId]
    156. 

  156.   if (!page) {
    157. 

  157.     console.error(`Connect to unknown extension ${extensionId}`)
    158. 

  158.     return
    159. 

  159.   }
    160. 

  160. 

  161.   const portId = ++nextId
    162. 

  162.   event.returnValue = {tabId: page.webContents.id, portId: portId}
    163. 

  163. 

  164.   event.sender.once('render-view-deleted', () => {
    165. 

  165.     if (page.webContents.isDestroyed()) return
    166. 

  166.     page.webContents.sendToAll(`CHROME_PORT_DISCONNECT_${portId}`)
    167. 

  167.   })
    168. 

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

  169. })
    170. 

  170. 

  171. ipcMain.on('CHROME_I18N_MANIFEST', function (event, extensionId) {
    172. 

  172.   event.returnValue = manifestMap[extensionId]
    173. 

  173. })
    174. 

  174. 

  175. let resultID = 1
    176. 

  176. ipcMain.on('CHROME_RUNTIME_SENDMESSAGE', function (event, extensionId, message, originResultID) {
    177. 

  177.   const page = backgroundPages[extensionId]
    178. 

  178.   if (!page) {
    179. 

  179.     console.error(`Connect to unknown extension ${extensionId}`)
    180. 

  180.     return
    181. 

  181.   }
    182. 

  182. 

  183.   page.webContents.sendToAll(`CHROME_RUNTIME_ONMESSAGE_${extensionId}`, event.sender.id, message, resultID)
    184. 

  184.   ipcMain.once(`CHROME_RUNTIME_ONMESSAGE_RESULT_${resultID}`, (event, result) => {
    185. 

  185.     event.sender.send(`CHROME_RUNTIME_SENDMESSAGE_RESULT_${originResultID}`, result)
    186. 

  186.   })
    187. 

  187.   resultID++
    188. 

  188. })
    189. 

  189. 

  190. ipcMain.on('CHROME_TABS_SEND_MESSAGE', function (event, tabId, extensionId, isBackgroundPage, message, originResultID) {
    191. 

  191.   const contents = webContents.fromId(tabId)
    192. 

  192.   if (!contents) {
    193. 

  193.     console.error(`Sending message to unknown tab ${tabId}`)
    194. 

  194.     return
    195. 

  195.   }
    196. 

  196. 

  197.   const senderTabId = isBackgroundPage ? null : event.sender.id
    198. 

  198. 

  199.   contents.sendToAll(`CHROME_RUNTIME_ONMESSAGE_${extensionId}`, senderTabId, message, resultID)
    200. 

  200.   ipcMain.once(`CHROME_RUNTIME_ONMESSAGE_RESULT_${resultID}`, (event, result) => {
    201. 

  201.     event.sender.send(`CHROME_TABS_SEND_MESSAGE_RESULT_${originResultID}`, result)
    202. 

  202.   })
    203. 

  203.   resultID++
    204. 

  204. })
    205. 

  205. 

  206. ipcMain.on('CHROME_TABS_EXECUTESCRIPT', function (event, requestId, tabId, extensionId, details) {
    207. 

  207.   const contents = webContents.fromId(tabId)
    208. 

  208.   if (!contents) {
    209. 

  209.     console.error(`Sending message to unknown tab ${tabId}`)
    210. 

  210.     return
    211. 

  211.   }
    212. 

  212. 

  213.   let code, url
    214. 

  214.   if (details.file) {
    215. 

  215.     const manifest = manifestMap[extensionId]
    216. 

  216.     code = String(fs.readFileSync(path.join(manifest.srcDirectory, details.file)))
    217. 

  217.     url = `chrome-extension://${extensionId}${details.file}`
    218. 

  218.   } else {
    219. 

  219.     code = details.code
    220. 

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

  221.   }
    222. 

  222. 

  223.   contents.send('CHROME_TABS_EXECUTESCRIPT', event.sender.id, requestId, extensionId, url, code)
    224. 

  224. })
    225. 

  225. 

  226. // Transfer the content scripts to renderer.
    227. 

  227. const contentScripts = {}
    228. 

  228. 

  229. const injectContentScripts = function (manifest) {
    230. 

  230.   if (contentScripts[manifest.name] || !manifest.content_scripts) return
    231. 

  231. 

  232.   const readArrayOfFiles = function (relativePath) {
    233. 

  233.     return {
    234. 

  234.       url: `chrome-extension://${manifest.extensionId}/${relativePath}`,
    235. 

  235.       code: String(fs.readFileSync(path.join(manifest.srcDirectory, relativePath)))
    236. 

  236.     }
    237. 

  237.   }
    238. 

  238. 

  239.   const contentScriptToEntry = function (script) {
    240. 

  240.     return {
    241. 

  241.       matches: script.matches,
    242. 

  242.       js: script.js.map(readArrayOfFiles),
    243. 

  243.       runAt: script.run_at || 'document_idle'
    244. 

  244.     }
    245. 

  245.   }
    246. 

  246. 

  247.   try {
    248. 

  248.     const entry = {
    249. 

  249.       extensionId: manifest.extensionId,
    250. 

  250.       contentScripts: manifest.content_scripts.map(contentScriptToEntry)
    251. 

  251.     }
    252. 

  252.     contentScripts[manifest.name] = renderProcessPreferences.addEntry(entry)
    253. 

  253.   } catch (e) {
    254. 

  254.     console.error('Failed to read content scripts', e)
    255. 

  255.   }
    256. 

  256. }
    257. 

  257. 

  258. const removeContentScripts = function (manifest) {
    259. 

  259.   if (!contentScripts[manifest.name]) return
    260. 

  260. 

  261.   renderProcessPreferences.removeEntry(contentScripts[manifest.name])
    262. 

  262.   delete contentScripts[manifest.name]
    263. 

  263. }
    264. 

  264. 

  265. // Transfer the |manifest| to a format that can be recognized by the
    266. 

  266. // |DevToolsAPI.addExtensions|.
    267. 

  267. const manifestToExtensionInfo = function (manifest) {
    268. 

  268.   return {
    269. 

  269.     startPage: manifest.startPage,
    270. 

  270.     srcDirectory: manifest.srcDirectory,
    271. 

  271.     name: manifest.name,
    272. 

  272.     exposeExperimentalAPIs: true
    273. 

  273.   }
    274. 

  274. }
    275. 

  275. 

  276. // Load the extensions for the window.
    277. 

  277. const loadExtension = function (manifest) {
    278. 

  278.   startBackgroundPages(manifest)
    279. 

  279.   injectContentScripts(manifest)
    280. 

  280. }
    281. 

  281. 

  282. const loadDevToolsExtensions = function (win, manifests) {
    283. 

  283.   if (!win.devToolsWebContents) return
    284. 

  284. 

  285.   manifests.forEach(loadExtension)
    286. 

  286. 

  287.   const extensionInfoArray = manifests.map(manifestToExtensionInfo)
    288. 

  288.   win.devToolsWebContents.executeJavaScript(`DevToolsAPI.addExtensions(${JSON.stringify(extensionInfoArray)})`)
    289. 

  289. }
    290. 

  290. 

  291. app.on('web-contents-created', function (event, webContents) {
    292. 

  292.   if (!isWindowOrWebView(webContents)) return
    293. 

  293. 

  294.   hookWebContentsEvents(webContents)
    295. 

  295.   webContents.on('devtools-opened', function () {
    296. 

  296.     loadDevToolsExtensions(webContents, objectValues(manifestMap))
    297. 

  297.   })
    298. 

  298. })
    299. 

  299. 

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

  301. const chromeExtensionHandler = function (request, callback) {
    302. 

  302.   const parsed = url.parse(request.url)
    303. 

  303.   if (!parsed.hostname || !parsed.path) return callback()
    304. 

  304. 

  305.   const manifest = manifestMap[parsed.hostname]
    306. 

  306.   if (!manifest) return callback()
    307. 

  307. 

  308.   const page = backgroundPages[parsed.hostname]
    309. 

  309.   if (page && parsed.path === `/${page.name}`) {
    310. 

  310.     return callback({
    311. 

  311.       mimeType: 'text/html',
    312. 

  312.       data: page.html
    313. 

  313.     })
    314. 

  314.   }
    315. 

  315. 

  316.   fs.readFile(path.join(manifest.srcDirectory, parsed.path), function (err, content) {
    317. 

  317.     if (err) {
    318. 

  318.       return callback(-6)  // FILE_NOT_FOUND
    319. 

  319.     } else {
    320. 

  320.       return callback(content)
    321. 

  321.     }
    322. 

  322.   })
    323. 

  323. }
    324. 

  324. 

  325. app.on('session-created', function (ses) {
    326. 

  326.   ses.protocol.registerBufferProtocol('chrome-extension', chromeExtensionHandler, function (error) {
    327. 

  327.     if (error) {
    328. 

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

  329.     }
    330. 

  330.   })
    331. 

  331. })
    332. 

  332. 

  333. // The persistent path of "DevTools Extensions" preference file.
    334. 

  334. let loadedDevToolsExtensionsPath = null
    335. 

  335. 

  336. app.on('will-quit', function () {
    337. 

  337.   try {
    338. 

  338.     const loadedDevToolsExtensions = Array.from(devToolsExtensionNames)
    339. 

  339.       .map(name => manifestNameMap[name].srcDirectory)
    340. 

  340.     if (loadedDevToolsExtensions.length > 0) {
    341. 

  341.       try {
    342. 

  342.         fs.mkdirSync(path.dirname(loadedDevToolsExtensionsPath))
    343. 

  343.       } catch (error) {
    344. 

  344.         // Ignore error
    345. 

  345.       }
    346. 

  346.       fs.writeFileSync(loadedDevToolsExtensionsPath, JSON.stringify(loadedDevToolsExtensions))
    347. 

  347.     } else {
    348. 

  348.       fs.unlinkSync(loadedDevToolsExtensionsPath)
    349. 

  349.     }
    350. 

  350.   } catch (error) {
    351. 

  351.     // Ignore error
    352. 

  352.   }
    353. 

  353. })
    354. 

  354. 

  355. // We can not use protocol or BrowserWindow until app is ready.
    356. 

  356. app.once('ready', function () {
    357. 

  357.   // Load persisted extensions.
    358. 

  358.   loadedDevToolsExtensionsPath = path.join(app.getPath('userData'), 'DevTools Extensions')
    359. 

  359.   try {
    360. 

  360.     const loadedDevToolsExtensions = JSON.parse(fs.readFileSync(loadedDevToolsExtensionsPath))
    361. 

  361.     if (Array.isArray(loadedDevToolsExtensions)) {
    362. 

  362.       for (const srcDirectory of loadedDevToolsExtensions) {
    363. 

  363.         // Start background pages and set content scripts.
    364. 

  364.         BrowserWindow.addDevToolsExtension(srcDirectory)
    365. 

  365.       }
    366. 

  366.     }
    367. 

  367.   } catch (error) {
    368. 

  368.     // Ignore error
    369. 

  369.   }
    370. 

  370. 

  371.   // The public API to add/remove extensions.
    372. 

  372.   BrowserWindow.addExtension = function (srcDirectory) {
    373. 

  373.     const manifest = getManifestFromPath(srcDirectory)
    374. 

  374.     if (manifest) {
    375. 

  375.       loadExtension(manifest)
    376. 

  376.       for (const webContents of getAllWebContents()) {
    377. 

  377.         if (isWindowOrWebView(webContents)) {
    378. 

  378.           loadDevToolsExtensions(webContents, [manifest])
    379. 

  379.         }
    380. 

  380.       }
    381. 

  381.       return manifest.name
    382. 

  382.     }
    383. 

  383.   }
    384. 

  384. 

  385.   BrowserWindow.removeExtension = function (name) {
    386. 

  386.     const manifest = manifestNameMap[name]
    387. 

  387.     if (!manifest) return
    388. 

  388. 

  389.     removeBackgroundPages(manifest)
    390. 

  390.     removeContentScripts(manifest)
    391. 

  391.     delete manifestMap[manifest.extensionId]
    392. 

  392.     delete manifestNameMap[name]
    393. 

  393.   }
    394. 

  394. 

  395.   BrowserWindow.getExtensions = function () {
    396. 

  396.     const extensions = {}
    397. 

  397.     Object.keys(manifestNameMap).forEach(function (name) {
    398. 

  398.       const manifest = manifestNameMap[name]
    399. 

  399.       extensions[name] = {name: manifest.name, version: manifest.version}
    400. 

  400.     })
    401. 

  401.     return extensions
    402. 

  402.   }
    403. 

  403. 

  404.   BrowserWindow.addDevToolsExtension = function (srcDirectory) {
    405. 

  405.     const manifestName = BrowserWindow.addExtension(srcDirectory)
    406. 

  406.     if (manifestName) {
    407. 

  407.       devToolsExtensionNames.add(manifestName)
    408. 

  408.     }
    409. 

  409.     return manifestName
    410. 

  410.   }
    411. 

  411. 

  412.   BrowserWindow.removeDevToolsExtension = function (name) {
    413. 

  413.     BrowserWindow.removeExtension(name)
    414. 

  414.     devToolsExtensionNames.delete(name)
    415. 

  415.   }
    416. 

  416. 

  417.   BrowserWindow.getDevToolsExtensions = function () {
    418. 

  418.     const extensions = BrowserWindow.getExtensions()
    419. 

  419.     const devExtensions = {}
    420. 

  420.     Array.from(devToolsExtensionNames).forEach(function (name) {
    421. 

  421.       if (!extensions[name]) return
    422. 

  422.       devExtensions[name] = extensions[name]
    423. 

  423.     })
    424. 

  424.     return devExtensions
    425. 

  425.   }
    426. 

  426. })
    427.