diff options
author | Markus Hatvan <markus_hatvan@aon.at> | 2021-10-14 09:32:20 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-14 13:02:20 +0530 |
commit | 52211095aab71f8b59b093b19ae34c222be9f390 (patch) | |
tree | 28f24a9be5ee5577667cdd396fb3fc64fc861e65 /src/webview/contextMenuBuilder.js | |
parent | chore: convert class components to functional (#2065) (diff) | |
download | ferdium-app-52211095aab71f8b59b093b19ae34c222be9f390.tar.gz ferdium-app-52211095aab71f8b59b093b19ae34c222be9f390.tar.zst ferdium-app-52211095aab71f8b59b093b19ae34c222be9f390.zip |
chore: convert various JS to TS (#2062)
Diffstat (limited to 'src/webview/contextMenuBuilder.js')
-rw-r--r-- | src/webview/contextMenuBuilder.js | 622 |
1 files changed, 0 insertions, 622 deletions
diff --git a/src/webview/contextMenuBuilder.js b/src/webview/contextMenuBuilder.js deleted file mode 100644 index 938eade1e..000000000 --- a/src/webview/contextMenuBuilder.js +++ /dev/null | |||
@@ -1,622 +0,0 @@ | |||
1 | /** | ||
2 | * Context Menu builder. | ||
3 | * | ||
4 | * Based on "electron-spellchecker"'s ContextMenuBuilder but customized for Ferdi | ||
5 | * and for usage with Electron's build-in spellchecker | ||
6 | * | ||
7 | * Source: https://github.com/electron-userland/electron-spellchecker/blob/master/src/context-menu-builder.js | ||
8 | */ | ||
9 | // eslint-disable-next-line no-unused-vars | ||
10 | import { clipboard, ipcRenderer, nativeImage, WebContents } from 'electron'; | ||
11 | import { Menu, MenuItem } from '@electron/remote'; | ||
12 | import { cmdOrCtrlShortcutKey, isMac } from '../environment'; | ||
13 | |||
14 | import { SEARCH_ENGINE_NAMES, SEARCH_ENGINE_URLS } from '../config'; | ||
15 | import { openExternalUrl } from '../helpers/url-helpers'; | ||
16 | |||
17 | const { URL } = require('url'); | ||
18 | |||
19 | function matchesWord(string) { | ||
20 | const regex = | ||
21 | /[A-Za-z\u00AA\u00B5\u00BA\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02C1\u02C6-\u02D1\u02E0-\u02E4\u02EC\u02EE\u0370-\u0374\u0376\u0377\u037A-\u037D\u0386\u0388-\u038A\u038C\u038E-\u03A1\u03A3-\u03F5\u03F7-\u0481\u048A-\u0527\u0531-\u0556\u0559\u0561-\u0587\u05D0-\u05EA\u05F0-\u05F2\u0620-\u064A\u066E\u066F\u0671-\u06D3\u06D5\u06E5\u06E6\u06EE\u06EF\u06FA-\u06FC\u06FF\u0710\u0712-\u072F\u074D-\u07A5\u07B1\u07CA-\u07EA\u07F4\u07F5\u07FA\u0800-\u0815\u081A\u0824\u0828\u0840-\u0858\u08A0\u08A2-\u08AC\u0904-\u0939\u093D\u0950\u0958-\u0961\u0971-\u0977\u0979-\u097F\u0985-\u098C\u098F\u0990\u0993-\u09A8\u09AA-\u09B0\u09B2\u09B6-\u09B9\u09BD\u09CE\u09DC\u09DD\u09DF-\u09E1\u09F0\u09F1\u0A05-\u0A0A\u0A0F\u0A10\u0A13-\u0A28\u0A2A-\u0A30\u0A32\u0A33\u0A35\u0A36\u0A38\u0A39\u0A59-\u0A5C\u0A5E\u0A72-\u0A74\u0A85-\u0A8D\u0A8F-\u0A91\u0A93-\u0AA8\u0AAA-\u0AB0\u0AB2\u0AB3\u0AB5-\u0AB9\u0ABD\u0AD0\u0AE0\u0AE1\u0B05-\u0B0C\u0B0F\u0B10\u0B13-\u0B28\u0B2A-\u0B30\u0B32\u0B33\u0B35-\u0B39\u0B3D\u0B5C\u0B5D\u0B5F-\u0B61\u0B71\u0B83\u0B85-\u0B8A\u0B8E-\u0B90\u0B92-\u0B95\u0B99\u0B9A\u0B9C\u0B9E\u0B9F\u0BA3\u0BA4\u0BA8-\u0BAA\u0BAE-\u0BB9\u0BD0\u0C05-\u0C0C\u0C0E-\u0C10\u0C12-\u0C28\u0C2A-\u0C33\u0C35-\u0C39\u0C3D\u0C58\u0C59\u0C60\u0C61\u0C85-\u0C8C\u0C8E-\u0C90\u0C92-\u0CA8\u0CAA-\u0CB3\u0CB5-\u0CB9\u0CBD\u0CDE\u0CE0\u0CE1\u0CF1\u0CF2\u0D05-\u0D0C\u0D0E-\u0D10\u0D12-\u0D3A\u0D3D\u0D4E\u0D60\u0D61\u0D7A-\u0D7F\u0D85-\u0D96\u0D9A-\u0DB1\u0DB3-\u0DBB\u0DBD\u0DC0-\u0DC6\u0E01-\u0E30\u0E32\u0E33\u0E40-\u0E46\u0E81\u0E82\u0E84\u0E87\u0E88\u0E8A\u0E8D\u0E94-\u0E97\u0E99-\u0E9F\u0EA1-\u0EA3\u0EA5\u0EA7\u0EAA\u0EAB\u0EAD-\u0EB0\u0EB2\u0EB3\u0EBD\u0EC0-\u0EC4\u0EC6\u0EDC-\u0EDF\u0F00\u0F40-\u0F47\u0F49-\u0F6C\u0F88-\u0F8C\u1000-\u102A\u103F\u1050-\u1055\u105A-\u105D\u1061\u1065\u1066\u106E-\u1070\u1075-\u1081\u108E\u10A0-\u10C5\u10C7\u10CD\u10D0-\u10FA\u10FC-\u1248\u124A-\u124D\u1250-\u1256\u1258\u125A-\u125D\u1260-\u1288\u128A-\u128D\u1290-\u12B0\u12B2-\u12B5\u12B8-\u12BE\u12C0\u12C2-\u12C5\u12C8-\u12D6\u12D8-\u1310\u1312-\u1315\u1318-\u135A\u1380-\u138F\u13A0-\u13F4\u1401-\u166C\u166F-\u167F\u1681-\u169A\u16A0-\u16EA\u1700-\u170C\u170E-\u1711\u1720-\u1731\u1740-\u1751\u1760-\u176C\u176E-\u1770\u1780-\u17B3\u17D7\u17DC\u1820-\u1877\u1880-\u18A8\u18AA\u18B0-\u18F5\u1900-\u191C\u1950-\u196D\u1970-\u1974\u1980-\u19AB\u19C1-\u19C7\u1A00-\u1A16\u1A20-\u1A54\u1AA7\u1B05-\u1B33\u1B45-\u1B4B\u1B83-\u1BA0\u1BAE\u1BAF\u1BBA-\u1BE5\u1C00-\u1C23\u1C4D-\u1C4F\u1C5A-\u1C7D\u1CE9-\u1CEC\u1CEE-\u1CF1\u1CF5\u1CF6\u1D00-\u1DBF\u1E00-\u1F15\u1F18-\u1F1D\u1F20-\u1F45\u1F48-\u1F4D\u1F50-\u1F57\u1F59\u1F5B\u1F5D\u1F5F-\u1F7D\u1F80-\u1FB4\u1FB6-\u1FBC\u1FBE\u1FC2-\u1FC4\u1FC6-\u1FCC\u1FD0-\u1FD3\u1FD6-\u1FDB\u1FE0-\u1FEC\u1FF2-\u1FF4\u1FF6-\u1FFC\u2071\u207F\u2090-\u209C\u2102\u2107\u210A-\u2113\u2115\u2119-\u211D\u2124\u2126\u2128\u212A-\u212D\u212F-\u2139\u213C-\u213F\u2145-\u2149\u214E\u2183\u2184\u2C00-\u2C2E\u2C30-\u2C5E\u2C60-\u2CE4\u2CEB-\u2CEE\u2CF2\u2CF3\u2D00-\u2D25\u2D27\u2D2D\u2D30-\u2D67\u2D6F\u2D80-\u2D96\u2DA0-\u2DA6\u2DA8-\u2DAE\u2DB0-\u2DB6\u2DB8-\u2DBE\u2DC0-\u2DC6\u2DC8-\u2DCE\u2DD0-\u2DD6\u2DD8-\u2DDE\u2E2F\u3005\u3006\u3031-\u3035\u303B\u303C\u3041-\u3096\u309D-\u309F\u30A1-\u30FA\u30FC-\u30FF\u3105-\u312D\u3131-\u318E\u31A0-\u31BA\u31F0-\u31FF\u3400-\u4DB5\u4E00-\u9FCC\uA000-\uA48C\uA4D0-\uA4FD\uA500-\uA60C\uA610-\uA61F\uA62A\uA62B\uA640-\uA66E\uA67F-\uA697\uA6A0-\uA6E5\uA717-\uA71F\uA722-\uA788\uA78B-\uA78E\uA790-\uA793\uA7A0-\uA7AA\uA7F8-\uA801\uA803-\uA805\uA807-\uA80A\uA80C-\uA822\uA840-\uA873\uA882-\uA8B3\uA8F2-\uA8F7\uA8FB\uA90A-\uA925\uA930-\uA946\uA960-\uA97C\uA984-\uA9B2\uA9CF\uAA00-\uAA28\uAA40-\uAA42\uAA44-\uAA4B\uAA60-\uAA76\uAA7A\uAA80-\uAAAF\uAAB1\uAAB5\uAAB6\uAAB9-\uAABD\uAAC0\uAAC2\uAADB-\uAADD\uAAE0-\uAAEA\uAAF2-\uAAF4\uAB01-\uAB06\uAB09-\uAB0E\uAB11-\uAB16\uAB20-\uAB26\uAB28-\uAB2E\uABC0-\uABE2\uAC00-\uD7A3\uD7B0-\uD7C6\uD7CB-\uD7FB\uF900-\uFA6D\uFA70-\uFAD9\uFB00-\uFB06\uFB13-\uFB17\uFB1D\uFB1F-\uFB28\uFB2A-\uFB36\uFB38-\uFB3C\uFB3E\uFB40\uFB41\uFB43\uFB44\uFB46-\uFBB1\uFBD3-\uFD3D\uFD50-\uFD8F\uFD92-\uFDC7\uFDF0-\uFDFB\uFE70-\uFE74\uFE76-\uFEFC\uFF21-\uFF3A\uFF41-\uFF5A\uFF66-\uFFBE\uFFC2-\uFFC7\uFFCA-\uFFCF\uFFD2-\uFFD7\uFFDA-\uFFDC]+/g; | ||
22 | |||
23 | return string.match(regex); | ||
24 | } | ||
25 | |||
26 | // TODO: Need to externalize for i18n | ||
27 | const contextMenuStringTable = { | ||
28 | lookUpDefinition: ({ word }) => `Look Up "${word}"`, | ||
29 | cut: () => 'Cut', | ||
30 | copy: () => 'Copy', | ||
31 | paste: () => 'Paste', | ||
32 | pasteAndMatchStyle: () => 'Paste and match style', | ||
33 | searchWith: ({ searchEngine }) => `Search with ${searchEngine}`, | ||
34 | openLinkUrl: () => 'Open Link', | ||
35 | openLinkInFerdiUrl: () => 'Open Link in Ferdi', | ||
36 | openInBrowser: () => 'Open in Browser', | ||
37 | copyLinkUrl: () => 'Copy Link', | ||
38 | copyImageUrl: () => 'Copy Image Address', | ||
39 | copyImage: () => 'Copy Image', | ||
40 | downloadImage: () => 'Download Image', | ||
41 | addToDictionary: () => 'Add to Dictionary', | ||
42 | goBack: () => 'Go Back', | ||
43 | goForward: () => 'Go Forward', | ||
44 | copyPageUrl: () => 'Copy Page URL', | ||
45 | goToHomePage: () => 'Go to Home Page', | ||
46 | copyMail: () => 'Copy Email Address', | ||
47 | inspectElement: () => 'Inspect Element', | ||
48 | }; | ||
49 | |||
50 | /** | ||
51 | * ContextMenuBuilder creates context menus based on the content clicked - this | ||
52 | * information is derived from | ||
53 | * https://github.com/electron/electron/blob/master/docs/api/web-contents.md#event-context-menu, | ||
54 | * which we use to generate the menu. We also use the spell-check information to | ||
55 | * generate suggestions. | ||
56 | */ | ||
57 | module.exports = class ContextMenuBuilder { | ||
58 | /** | ||
59 | * Creates an instance of ContextMenuBuilder | ||
60 | * | ||
61 | * @param {WebContents} webContents Current webContents | ||
62 | * @param {Boolean} debugMode If true, display the "Inspect Element" menu item. | ||
63 | * @param {function} processMenu If passed, this method will be passed the menu to change | ||
64 | * it prior to display. Signature: (menu, info) => menu | ||
65 | */ | ||
66 | constructor(webContents, debugMode = false, processMenu = m => m) { | ||
67 | this.debugMode = debugMode; | ||
68 | this.processMenu = processMenu; | ||
69 | this.menu = null; | ||
70 | this.stringTable = { ...contextMenuStringTable }; | ||
71 | this.getWebContents = () => webContents; | ||
72 | } | ||
73 | |||
74 | /** | ||
75 | * Specify alternate string formatter for each context menu. | ||
76 | * String table consist of string formatter as function instead per each context menu item, | ||
77 | * allows to change string in runtime. All formatters are simply typeof () => string, except | ||
78 | * lookUpDefinition provides word, ({word}) => string. | ||
79 | * | ||
80 | * @param {Object} stringTable The object contains string foramtter function for context menu. | ||
81 | * It is allowed to specify only certain menu string as necessary, which will makes other string | ||
82 | * fall backs to default. | ||
83 | * | ||
84 | */ | ||
85 | setAlternateStringFormatter(stringTable) { | ||
86 | this.stringTable = Object.assign(this.stringTable, stringTable); | ||
87 | } | ||
88 | |||
89 | /** | ||
90 | * Shows a popup menu given the information returned from the context-menu | ||
91 | * event. This is probably the only method you need to call in this class. | ||
92 | * | ||
93 | * @param {Object} contextInfo The object returned from the 'context-menu' | ||
94 | * Electron event. | ||
95 | * | ||
96 | * @return {Promise} Completion | ||
97 | */ | ||
98 | async showPopupMenu(contextInfo) { | ||
99 | const menu = await this.buildMenuForElement(contextInfo); | ||
100 | if (!menu) return; | ||
101 | menu.popup(); | ||
102 | } | ||
103 | |||
104 | /** | ||
105 | * Builds a context menu specific to the given info that _would_ be shown | ||
106 | * immediately by {{showPopupMenu}}. Use this to add your own menu items to | ||
107 | * the list but use most of the default behavior. | ||
108 | * | ||
109 | * @return {Promise<Menu>} The newly created `Menu` | ||
110 | */ | ||
111 | async buildMenuForElement(info) { | ||
112 | if (info.linkURL && info.linkURL.length > 0) { | ||
113 | return this.buildMenuForLink(info); | ||
114 | } | ||
115 | |||
116 | if (info.hasImageContents && info.srcURL && info.srcURL.length > 1) { | ||
117 | return this.buildMenuForImage(info); | ||
118 | } | ||
119 | |||
120 | if ( | ||
121 | info.isEditable || | ||
122 | (info.inputFieldType && info.inputFieldType !== 'none') | ||
123 | ) { | ||
124 | return this.buildMenuForTextInput(info); | ||
125 | } | ||
126 | |||
127 | return this.buildMenuForText(info); | ||
128 | } | ||
129 | |||
130 | /** | ||
131 | * Builds a menu applicable to a text input field. | ||
132 | * | ||
133 | * @return {Menu} The `Menu` | ||
134 | */ | ||
135 | buildMenuForTextInput(menuInfo) { | ||
136 | const menu = new Menu(); | ||
137 | |||
138 | this.addSpellingItems(menu, menuInfo); | ||
139 | this.addSearchItems(menu, menuInfo); | ||
140 | |||
141 | this.addCut(menu, menuInfo); | ||
142 | this.addCopy(menu, menuInfo); | ||
143 | this.addPaste(menu, menuInfo); | ||
144 | this.addPastePlain(menu, menuInfo); | ||
145 | this.addInspectElement(menu, menuInfo); | ||
146 | this.processMenu(menu, menuInfo); | ||
147 | |||
148 | this.copyPageUrl(menu); | ||
149 | this.goToHomePage(menu, menuInfo); | ||
150 | this.openInBrowser(menu, menuInfo); | ||
151 | |||
152 | return menu; | ||
153 | } | ||
154 | |||
155 | /** | ||
156 | * Builds a menu applicable to a link element. | ||
157 | * | ||
158 | * @return {Menu} The `Menu` | ||
159 | */ | ||
160 | buildMenuForLink(menuInfo) { | ||
161 | const menu = new Menu(); | ||
162 | const isEmailAddress = menuInfo.linkURL.startsWith('mailto:'); | ||
163 | |||
164 | const copyLink = new MenuItem({ | ||
165 | label: isEmailAddress | ||
166 | ? this.stringTable.copyMail() | ||
167 | : this.stringTable.copyLinkUrl(), | ||
168 | click: () => { | ||
169 | // Omit the mailto: portion of the link; we just want the address | ||
170 | const url = isEmailAddress ? menuInfo.linkText : menuInfo.linkURL; | ||
171 | clipboard.writeText(url); | ||
172 | this._sendNotificationOnClipboardEvent( | ||
173 | menuInfo.clipboardNotifications, | ||
174 | () => `Link URL copied: ${url}`, | ||
175 | ); | ||
176 | }, | ||
177 | }); | ||
178 | |||
179 | const openLink = new MenuItem({ | ||
180 | label: this.stringTable.openLinkUrl(), | ||
181 | click: () => { | ||
182 | openExternalUrl(menuInfo.linkURL, true); | ||
183 | }, | ||
184 | }); | ||
185 | |||
186 | const openInFerdiLink = new MenuItem({ | ||
187 | label: this.stringTable.openLinkInFerdiUrl(), | ||
188 | click: () => { | ||
189 | window.location.href = menuInfo.linkURL; | ||
190 | }, | ||
191 | }); | ||
192 | |||
193 | menu.append(copyLink); | ||
194 | menu.append(openLink); | ||
195 | menu.append(openInFerdiLink); | ||
196 | |||
197 | if (this.isSrcUrlValid(menuInfo)) { | ||
198 | this.addSeparator(menu); | ||
199 | this.addImageItems(menu, menuInfo); | ||
200 | } | ||
201 | |||
202 | this.addInspectElement(menu, menuInfo); | ||
203 | this.processMenu(menu, menuInfo); | ||
204 | |||
205 | this.addSeparator(menu); | ||
206 | this.goBack(menu); | ||
207 | this.goForward(menu); | ||
208 | this.copyPageUrl(menu); | ||
209 | this.goToHomePage(menu, menuInfo); | ||
210 | this.openInBrowser(menu, menuInfo); | ||
211 | |||
212 | return menu; | ||
213 | } | ||
214 | |||
215 | /** | ||
216 | * Builds a menu applicable to a text field. | ||
217 | * | ||
218 | * @return {Menu} The `Menu` | ||
219 | */ | ||
220 | buildMenuForText(menuInfo) { | ||
221 | const menu = new Menu(); | ||
222 | |||
223 | this.addSearchItems(menu, menuInfo); | ||
224 | this.addCopy(menu, menuInfo); | ||
225 | this.addInspectElement(menu, menuInfo); | ||
226 | this.processMenu(menu, menuInfo); | ||
227 | |||
228 | this.addSeparator(menu); | ||
229 | this.goBack(menu); | ||
230 | this.goForward(menu); | ||
231 | this.copyPageUrl(menu, menuInfo); | ||
232 | this.goToHomePage(menu, menuInfo); | ||
233 | this.openInBrowser(menu, menuInfo); | ||
234 | |||
235 | return menu; | ||
236 | } | ||
237 | |||
238 | /** | ||
239 | * Builds a menu applicable to an image. | ||
240 | * | ||
241 | * @return {Menu} The `Menu` | ||
242 | */ | ||
243 | buildMenuForImage(menuInfo) { | ||
244 | const menu = new Menu(); | ||
245 | |||
246 | if (this.isSrcUrlValid(menuInfo)) { | ||
247 | this.addImageItems(menu, menuInfo); | ||
248 | } | ||
249 | this.addInspectElement(menu, menuInfo); | ||
250 | this.processMenu(menu, menuInfo); | ||
251 | |||
252 | return menu; | ||
253 | } | ||
254 | |||
255 | /** | ||
256 | * Checks if the current text selection contains a single misspelled word and | ||
257 | * if so, adds suggested spellings as individual menu items. | ||
258 | */ | ||
259 | addSpellingItems(menu, menuInfo) { | ||
260 | const webContents = this.getWebContents(); | ||
261 | // Add each spelling suggestion | ||
262 | for (const suggestion of menuInfo.dictionarySuggestions) { | ||
263 | menu.append( | ||
264 | new MenuItem({ | ||
265 | label: suggestion, | ||
266 | // eslint-disable-next-line no-loop-func | ||
267 | click: () => webContents.replaceMisspelling(suggestion), | ||
268 | }), | ||
269 | ); | ||
270 | } | ||
271 | |||
272 | // Allow users to add the misspelled word to the dictionary | ||
273 | if (menuInfo.misspelledWord) { | ||
274 | menu.append( | ||
275 | new MenuItem({ | ||
276 | label: this.stringTable.addToDictionary(), | ||
277 | click: () => | ||
278 | webContents.session.addWordToSpellCheckerDictionary( | ||
279 | menuInfo.misspelledWord, | ||
280 | ), | ||
281 | }), | ||
282 | ); | ||
283 | } | ||
284 | |||
285 | return menu; | ||
286 | } | ||
287 | |||
288 | /** | ||
289 | * Adds search-related menu items. | ||
290 | */ | ||
291 | addSearchItems(menu, menuInfo) { | ||
292 | if (!menuInfo.selectionText || menuInfo.selectionText.length === 0) { | ||
293 | return menu; | ||
294 | } | ||
295 | |||
296 | const match = matchesWord(menuInfo.selectionText); | ||
297 | if (!match || match.length === 0) { | ||
298 | return menu; | ||
299 | } | ||
300 | |||
301 | if (isMac) { | ||
302 | const webContents = this.getWebContents(); | ||
303 | |||
304 | const lookUpDefinition = new MenuItem({ | ||
305 | label: this.stringTable.lookUpDefinition({ | ||
306 | word: menuInfo.selectionText.trim(), | ||
307 | }), | ||
308 | click: () => webContents.showDefinitionForSelection(), | ||
309 | }); | ||
310 | |||
311 | menu.append(lookUpDefinition); | ||
312 | } | ||
313 | |||
314 | const search = new MenuItem({ | ||
315 | label: this.stringTable.searchWith({ | ||
316 | searchEngine: SEARCH_ENGINE_NAMES[menuInfo.searchEngine], | ||
317 | }), | ||
318 | click: () => { | ||
319 | const url = SEARCH_ENGINE_URLS[menuInfo.searchEngine]({ | ||
320 | searchTerm: encodeURIComponent(menuInfo.selectionText), | ||
321 | }); | ||
322 | openExternalUrl(url, true); | ||
323 | }, | ||
324 | }); | ||
325 | |||
326 | menu.append(search); | ||
327 | this.addSeparator(menu); | ||
328 | |||
329 | return menu; | ||
330 | } | ||
331 | |||
332 | isSrcUrlValid(menuInfo) { | ||
333 | return menuInfo.srcURL && menuInfo.srcURL.length > 0; | ||
334 | } | ||
335 | |||
336 | /** | ||
337 | * Adds "Copy Image" and "Copy Image URL" items when `src` is valid. | ||
338 | */ | ||
339 | addImageItems(menu, menuInfo) { | ||
340 | const copyImage = new MenuItem({ | ||
341 | label: this.stringTable.copyImage(), | ||
342 | click: () => { | ||
343 | const result = this.convertImageToBase64(menuInfo.srcURL, dataURL => | ||
344 | clipboard.writeImage(nativeImage.createFromDataURL(dataURL)), | ||
345 | ); | ||
346 | |||
347 | this._sendNotificationOnClipboardEvent( | ||
348 | menuInfo.clipboardNotifications, | ||
349 | () => `Image copied from URL: ${menuInfo.srcURL}`, | ||
350 | ); | ||
351 | return result; | ||
352 | }, | ||
353 | }); | ||
354 | |||
355 | menu.append(copyImage); | ||
356 | |||
357 | const copyImageUrl = new MenuItem({ | ||
358 | label: this.stringTable.copyImageUrl(), | ||
359 | click: () => { | ||
360 | const result = clipboard.writeText(menuInfo.srcURL); | ||
361 | this._sendNotificationOnClipboardEvent( | ||
362 | menuInfo.clipboardNotifications, | ||
363 | () => `Image URL copied: ${menuInfo.srcURL}`, | ||
364 | ); | ||
365 | return result; | ||
366 | }, | ||
367 | }); | ||
368 | |||
369 | menu.append(copyImageUrl); | ||
370 | |||
371 | // TODO: This doesn't seem to work on linux, so, limiting to Mac for now | ||
372 | if (isMac && menuInfo.srcURL.startsWith('blob:')) { | ||
373 | const downloadImage = new MenuItem({ | ||
374 | label: this.stringTable.downloadImage(), | ||
375 | click: () => { | ||
376 | const urlWithoutBlob = menuInfo.srcURL.slice(5); | ||
377 | this.convertImageToBase64(menuInfo.srcURL, dataURL => { | ||
378 | const url = new window.URL(urlWithoutBlob); | ||
379 | const fileName = url.pathname.slice(1); | ||
380 | ipcRenderer.send('download-file', { | ||
381 | content: dataURL, | ||
382 | fileOptions: { | ||
383 | name: fileName, | ||
384 | mime: 'image/png', | ||
385 | }, | ||
386 | }); | ||
387 | }); | ||
388 | this._sendNotificationOnClipboardEvent( | ||
389 | menuInfo.clipboardNotifications, | ||
390 | () => `Image downloaded: ${urlWithoutBlob}`, | ||
391 | ); | ||
392 | }, | ||
393 | }); | ||
394 | |||
395 | menu.append(downloadImage); | ||
396 | } | ||
397 | |||
398 | return menu; | ||
399 | } | ||
400 | |||
401 | /** | ||
402 | * Adds the Cut menu item | ||
403 | */ | ||
404 | addCut(menu, menuInfo) { | ||
405 | const webContents = this.getWebContents(); | ||
406 | menu.append( | ||
407 | new MenuItem({ | ||
408 | label: this.stringTable.cut(), | ||
409 | accelerator: `${cmdOrCtrlShortcutKey()}+X`, | ||
410 | enabled: menuInfo.editFlags.canCut, | ||
411 | click: () => webContents.cut(), | ||
412 | }), | ||
413 | ); | ||
414 | |||
415 | return menu; | ||
416 | } | ||
417 | |||
418 | /** | ||
419 | * Adds the Copy menu item. | ||
420 | */ | ||
421 | addCopy(menu, menuInfo) { | ||
422 | const webContents = this.getWebContents(); | ||
423 | menu.append( | ||
424 | new MenuItem({ | ||
425 | label: this.stringTable.copy(), | ||
426 | accelerator: `${cmdOrCtrlShortcutKey()}+C`, | ||
427 | enabled: menuInfo.editFlags.canCopy, | ||
428 | click: () => webContents.copy(), | ||
429 | }), | ||
430 | ); | ||
431 | |||
432 | return menu; | ||
433 | } | ||
434 | |||
435 | /** | ||
436 | * Adds the Paste menu item. | ||
437 | */ | ||
438 | addPaste(menu, menuInfo) { | ||
439 | const webContents = this.getWebContents(); | ||
440 | menu.append( | ||
441 | new MenuItem({ | ||
442 | label: this.stringTable.paste(), | ||
443 | accelerator: `${cmdOrCtrlShortcutKey()}+V`, | ||
444 | enabled: menuInfo.editFlags.canPaste, | ||
445 | click: () => webContents.paste(), | ||
446 | }), | ||
447 | ); | ||
448 | |||
449 | return menu; | ||
450 | } | ||
451 | |||
452 | addPastePlain(menu, menuInfo) { | ||
453 | if ( | ||
454 | menuInfo.editFlags.canPaste && | ||
455 | !menuInfo.linkText && | ||
456 | !menuInfo.hasImageContents | ||
457 | ) { | ||
458 | const webContents = this.getWebContents(); | ||
459 | menu.append( | ||
460 | new MenuItem({ | ||
461 | label: this.stringTable.pasteAndMatchStyle(), | ||
462 | accelerator: `${cmdOrCtrlShortcutKey()}+Shift+V`, | ||
463 | click: () => webContents.pasteAndMatchStyle(), | ||
464 | }), | ||
465 | ); | ||
466 | } | ||
467 | } | ||
468 | |||
469 | /** | ||
470 | * Adds a separator item. | ||
471 | */ | ||
472 | addSeparator(menu) { | ||
473 | menu.append(new MenuItem({ type: 'separator' })); | ||
474 | return menu; | ||
475 | } | ||
476 | |||
477 | /** | ||
478 | * Adds the "Inspect Element" menu item. | ||
479 | */ | ||
480 | addInspectElement(menu, menuInfo, needsSeparator = true) { | ||
481 | const webContents = this.getWebContents(); | ||
482 | if (!this.debugMode) return menu; | ||
483 | if (needsSeparator) this.addSeparator(menu); | ||
484 | |||
485 | const inspect = new MenuItem({ | ||
486 | label: this.stringTable.inspectElement(), | ||
487 | click: () => webContents.inspectElement(menuInfo.x, menuInfo.y), | ||
488 | }); | ||
489 | |||
490 | menu.append(inspect); | ||
491 | return menu; | ||
492 | } | ||
493 | |||
494 | /** | ||
495 | * Converts an image to a base-64 encoded string. | ||
496 | * | ||
497 | * @param {String} url The image URL | ||
498 | * @param {Function} callback A callback that will be invoked with the result | ||
499 | * @param {String} outputFormat The image format to use, defaults to 'image/png' | ||
500 | */ | ||
501 | convertImageToBase64(url, callback, outputFormat = 'image/png') { | ||
502 | let canvas = document.createElement('canvas'); | ||
503 | const ctx = canvas.getContext('2d'); | ||
504 | // eslint-disable-next-line no-undef | ||
505 | const img = new Image(); | ||
506 | img.crossOrigin = 'Anonymous'; | ||
507 | |||
508 | img.addEventListener('load', () => { | ||
509 | canvas.height = img.height; | ||
510 | canvas.width = img.width; | ||
511 | ctx?.drawImage(img, 0, 0); | ||
512 | |||
513 | const dataURL = canvas.toDataURL(outputFormat); | ||
514 | canvas = null; | ||
515 | callback(dataURL); | ||
516 | }); | ||
517 | |||
518 | img.src = url; | ||
519 | } | ||
520 | |||
521 | /** | ||
522 | * Adds the 'go back' menu item | ||
523 | */ | ||
524 | goBack(menu) { | ||
525 | const webContents = this.getWebContents(); | ||
526 | menu.append( | ||
527 | new MenuItem({ | ||
528 | label: this.stringTable.goBack(), | ||
529 | accelerator: `${cmdOrCtrlShortcutKey()}+left`, | ||
530 | enabled: webContents.canGoBack(), | ||
531 | click: () => webContents.goBack(), | ||
532 | }), | ||
533 | ); | ||
534 | |||
535 | return menu; | ||
536 | } | ||
537 | |||
538 | /** | ||
539 | * Adds the 'go forward' menu item | ||
540 | */ | ||
541 | goForward(menu) { | ||
542 | const webContents = this.getWebContents(); | ||
543 | menu.append( | ||
544 | new MenuItem({ | ||
545 | label: this.stringTable.goForward(), | ||
546 | accelerator: `${cmdOrCtrlShortcutKey()}+right`, | ||
547 | enabled: webContents.canGoForward(), | ||
548 | click: () => webContents.goForward(), | ||
549 | }), | ||
550 | ); | ||
551 | |||
552 | return menu; | ||
553 | } | ||
554 | |||
555 | /** | ||
556 | * Adds the 'copy page url' menu item. | ||
557 | */ | ||
558 | copyPageUrl(menu, menuInfo) { | ||
559 | menu.append( | ||
560 | new MenuItem({ | ||
561 | label: this.stringTable.copyPageUrl(), | ||
562 | enabled: true, | ||
563 | click: () => { | ||
564 | clipboard.writeText(window.location.href); | ||
565 | this._sendNotificationOnClipboardEvent( | ||
566 | menuInfo.clipboardNotifications, | ||
567 | () => `Page URL copied: ${window.location.href}`, | ||
568 | ); | ||
569 | }, | ||
570 | }), | ||
571 | ); | ||
572 | |||
573 | return menu; | ||
574 | } | ||
575 | |||
576 | /** | ||
577 | * Adds the 'go to home' menu item. | ||
578 | */ | ||
579 | goToHomePage(menu, menuInfo) { | ||
580 | const baseURL = new URL(menuInfo.pageURL); | ||
581 | menu.append( | ||
582 | new MenuItem({ | ||
583 | label: this.stringTable.goToHomePage(), | ||
584 | accelerator: `${cmdOrCtrlShortcutKey()}+Home`, | ||
585 | enabled: true, | ||
586 | click: () => { | ||
587 | // webContents.loadURL(baseURL.origin); | ||
588 | window.location.href = baseURL.origin; | ||
589 | }, | ||
590 | }), | ||
591 | ); | ||
592 | |||
593 | return menu; | ||
594 | } | ||
595 | |||
596 | /** | ||
597 | * Adds the 'open in browser' menu item. | ||
598 | */ | ||
599 | openInBrowser(menu, menuInfo) { | ||
600 | menu.append( | ||
601 | new MenuItem({ | ||
602 | label: this.stringTable.openInBrowser(), | ||
603 | enabled: true, | ||
604 | click: () => { | ||
605 | openExternalUrl(menuInfo.pageURL, true); | ||
606 | }, | ||
607 | }), | ||
608 | ); | ||
609 | |||
610 | return menu; | ||
611 | } | ||
612 | |||
613 | _sendNotificationOnClipboardEvent(isDisabled, notificationText) { | ||
614 | if (isDisabled) { | ||
615 | return; | ||
616 | } | ||
617 | // eslint-disable-next-line no-new | ||
618 | new window.Notification('Data copied into Clipboard', { | ||
619 | body: notificationText(), | ||
620 | }); | ||
621 | } | ||
622 | }; | ||