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.ts | |
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.ts')
-rw-r--r-- | src/webview/contextMenuBuilder.ts | 721 |
1 files changed, 721 insertions, 0 deletions
diff --git a/src/webview/contextMenuBuilder.ts b/src/webview/contextMenuBuilder.ts new file mode 100644 index 000000000..fda5fa8b8 --- /dev/null +++ b/src/webview/contextMenuBuilder.ts | |||
@@ -0,0 +1,721 @@ | |||
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 | function matchesWord(string: string) { | ||
18 | const regex = | ||
19 | /[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; | ||
20 | |||
21 | return string.match(regex); | ||
22 | } | ||
23 | |||
24 | interface ContextMenuStringTable { | ||
25 | lookUpDefinition: ({ word }: { word: string }) => string; | ||
26 | cut: () => string; | ||
27 | copy: () => string; | ||
28 | paste: () => string; | ||
29 | pasteAndMatchStyle: () => string; | ||
30 | searchWith: ({ searchEngine }: { searchEngine: string }) => string; | ||
31 | openLinkUrl: () => string; | ||
32 | openLinkInFerdiUrl: () => string; | ||
33 | openInBrowser: () => string; | ||
34 | copyLinkUrl: () => string; | ||
35 | copyImageUrl: () => string; | ||
36 | copyImage: () => string; | ||
37 | downloadImage: () => string; | ||
38 | addToDictionary: () => string; | ||
39 | goBack: () => string; | ||
40 | goForward: () => string; | ||
41 | copyPageUrl: () => string; | ||
42 | goToHomePage: () => string; | ||
43 | copyMail: () => string; | ||
44 | inspectElement: () => string; | ||
45 | } | ||
46 | |||
47 | // TODO: Need to externalize for i18n | ||
48 | const contextMenuStringTable: ContextMenuStringTable = { | ||
49 | lookUpDefinition: ({ word }) => `Look Up "${word}"`, | ||
50 | cut: () => 'Cut', | ||
51 | copy: () => 'Copy', | ||
52 | paste: () => 'Paste', | ||
53 | pasteAndMatchStyle: () => 'Paste and match style', | ||
54 | searchWith: ({ searchEngine }) => `Search with ${searchEngine}`, | ||
55 | openLinkUrl: () => 'Open Link', | ||
56 | openLinkInFerdiUrl: () => 'Open Link in Ferdi', | ||
57 | openInBrowser: () => 'Open in Browser', | ||
58 | copyLinkUrl: () => 'Copy Link', | ||
59 | copyImageUrl: () => 'Copy Image Address', | ||
60 | copyImage: () => 'Copy Image', | ||
61 | downloadImage: () => 'Download Image', | ||
62 | addToDictionary: () => 'Add to Dictionary', | ||
63 | goBack: () => 'Go Back', | ||
64 | goForward: () => 'Go Forward', | ||
65 | copyPageUrl: () => 'Copy Page URL', | ||
66 | goToHomePage: () => 'Go to Home Page', | ||
67 | copyMail: () => 'Copy Email Address', | ||
68 | inspectElement: () => 'Inspect Element', | ||
69 | }; | ||
70 | |||
71 | /** | ||
72 | * ContextMenuBuilder creates context menus based on the content clicked - this | ||
73 | * information is derived from | ||
74 | * https://github.com/electron/electron/blob/master/docs/api/web-contents.md#event-context-menu, | ||
75 | * which we use to generate the menu. We also use the spell-check information to | ||
76 | * generate suggestions. | ||
77 | */ | ||
78 | export class ContextMenuBuilder { | ||
79 | debugMode: boolean; | ||
80 | |||
81 | processMenu: ( | ||
82 | menu: Electron.CrossProcessExports.Menu, | ||
83 | ) => Electron.CrossProcessExports.Menu; | ||
84 | |||
85 | menu: Electron.CrossProcessExports.Menu | null; | ||
86 | |||
87 | stringTable: ContextMenuStringTable; | ||
88 | |||
89 | getWebContents: () => Electron.WebContents; | ||
90 | |||
91 | /** | ||
92 | * Creates an instance of ContextMenuBuilder | ||
93 | * | ||
94 | * @param webContents Current webContents | ||
95 | * @param debugMode If true, display the "Inspect Element" menu item. | ||
96 | * @param processMenu If passed, this method will be passed the menu to change it prior to display. Signature: (menu, info) => menu | ||
97 | */ | ||
98 | constructor( | ||
99 | webContents: WebContents, | ||
100 | debugMode: boolean = false, | ||
101 | processMenu = (menu: Electron.CrossProcessExports.Menu) => menu, | ||
102 | ) { | ||
103 | this.debugMode = debugMode; | ||
104 | this.processMenu = processMenu; | ||
105 | this.menu = null; | ||
106 | this.stringTable = { ...contextMenuStringTable }; | ||
107 | this.getWebContents = () => webContents; | ||
108 | } | ||
109 | |||
110 | /** | ||
111 | * Specify alternate string formatter for each context menu. | ||
112 | * String table consist of string formatter as function instead per each context menu item, | ||
113 | * allows to change string in runtime. All formatters are simply typeof () => string, except | ||
114 | * lookUpDefinition provides word, ({word}) => string. | ||
115 | * | ||
116 | * @param stringTable The object contains string formatter function for context menu. | ||
117 | * It is allowed to specify only certain menu string as necessary, which will makes other string | ||
118 | * fall backs to default. | ||
119 | */ | ||
120 | setAlternateStringFormatter(stringTable: ContextMenuStringTable) { | ||
121 | this.stringTable = Object.assign(this.stringTable, stringTable); | ||
122 | } | ||
123 | |||
124 | /** | ||
125 | * Shows a popup menu given the information returned from the context-menu | ||
126 | * event. This is probably the only method you need to call in this class. | ||
127 | * | ||
128 | * @param contextInfo The object returned from the 'context-menu' Electron event. | ||
129 | */ | ||
130 | async showPopupMenu(contextInfo: Electron.ContextMenuParams): Promise<void> { | ||
131 | const menu = await this.buildMenuForElement(contextInfo); | ||
132 | if (!menu) return; | ||
133 | menu.popup(); | ||
134 | } | ||
135 | |||
136 | /** | ||
137 | * Builds a context menu specific to the given info that _would_ be shown | ||
138 | * immediately by {{showPopupMenu}}. Use this to add your own menu items to | ||
139 | * the list but use most of the default behavior. | ||
140 | */ | ||
141 | async buildMenuForElement( | ||
142 | info: Electron.ContextMenuParams, | ||
143 | ): Promise<Electron.CrossProcessExports.Menu> { | ||
144 | if (info.linkURL && info.linkURL.length > 0) { | ||
145 | return this.buildMenuForLink(info); | ||
146 | } | ||
147 | |||
148 | if (info.hasImageContents && info.srcURL && info.srcURL.length > 1) { | ||
149 | return this.buildMenuForImage(info); | ||
150 | } | ||
151 | |||
152 | if ( | ||
153 | info.isEditable || | ||
154 | (info.inputFieldType && info.inputFieldType !== 'none') | ||
155 | ) { | ||
156 | return this.buildMenuForTextInput(info); | ||
157 | } | ||
158 | |||
159 | return this.buildMenuForText(info); | ||
160 | } | ||
161 | |||
162 | /** | ||
163 | * Builds a menu applicable to a text input field. | ||
164 | * | ||
165 | * @return {Menu} The `Menu` | ||
166 | */ | ||
167 | buildMenuForTextInput( | ||
168 | menuInfo: Electron.ContextMenuParams, | ||
169 | ): Electron.CrossProcessExports.Menu { | ||
170 | const menu = new Menu(); | ||
171 | |||
172 | this.addSpellingItems(menu, menuInfo); | ||
173 | this.addSearchItems(menu, menuInfo); | ||
174 | |||
175 | this.addCut(menu, menuInfo); | ||
176 | this.addCopy(menu, menuInfo); | ||
177 | this.addPaste(menu, menuInfo); | ||
178 | this.addPastePlain(menu, menuInfo); | ||
179 | this.addInspectElement(menu, menuInfo); | ||
180 | // @ts-expect-error Expected 1 arguments, but got 2. | ||
181 | this.processMenu(menu, menuInfo); | ||
182 | |||
183 | // @ts-expect-error Expected 2 arguments, but got 1. | ||
184 | this.copyPageUrl(menu); | ||
185 | this.goToHomePage(menu, menuInfo); | ||
186 | this.openInBrowser(menu, menuInfo); | ||
187 | |||
188 | return menu; | ||
189 | } | ||
190 | |||
191 | /** | ||
192 | * Builds a menu applicable to a link element. | ||
193 | * | ||
194 | * @return {Menu} The `Menu` | ||
195 | */ | ||
196 | buildMenuForLink( | ||
197 | menuInfo: Electron.ContextMenuParams, | ||
198 | ): Electron.CrossProcessExports.Menu { | ||
199 | const menu = new Menu(); | ||
200 | const isEmailAddress = menuInfo.linkURL.startsWith('mailto:'); | ||
201 | |||
202 | const copyLink = new MenuItem({ | ||
203 | label: isEmailAddress | ||
204 | ? this.stringTable.copyMail() | ||
205 | : this.stringTable.copyLinkUrl(), | ||
206 | click: () => { | ||
207 | // Omit the mailto: portion of the link; we just want the address | ||
208 | const url = isEmailAddress ? menuInfo.linkText : menuInfo.linkURL; | ||
209 | clipboard.writeText(url); | ||
210 | this._sendNotificationOnClipboardEvent( | ||
211 | // @ts-expect-error Property 'clipboardNotifications' does not exist on type 'ContextMenuParams'. | ||
212 | menuInfo.clipboardNotifications, | ||
213 | () => `Link URL copied: ${url}`, | ||
214 | ); | ||
215 | }, | ||
216 | }); | ||
217 | |||
218 | const openLink = new MenuItem({ | ||
219 | label: this.stringTable.openLinkUrl(), | ||
220 | click: () => { | ||
221 | openExternalUrl(menuInfo.linkURL, true); | ||
222 | }, | ||
223 | }); | ||
224 | |||
225 | const openInFerdiLink = new MenuItem({ | ||
226 | label: this.stringTable.openLinkInFerdiUrl(), | ||
227 | click: () => { | ||
228 | window.location.href = menuInfo.linkURL; | ||
229 | }, | ||
230 | }); | ||
231 | |||
232 | menu.append(copyLink); | ||
233 | menu.append(openLink); | ||
234 | menu.append(openInFerdiLink); | ||
235 | |||
236 | if (this.isSrcUrlValid(menuInfo)) { | ||
237 | this.addSeparator(menu); | ||
238 | this.addImageItems(menu, menuInfo); | ||
239 | } | ||
240 | |||
241 | this.addInspectElement(menu, menuInfo); | ||
242 | // @ts-expect-error Expected 1 arguments, but got 2. | ||
243 | this.processMenu(menu, menuInfo); | ||
244 | |||
245 | this.addSeparator(menu); | ||
246 | this.goBack(menu); | ||
247 | this.goForward(menu); | ||
248 | // @ts-expect-error Expected 2 arguments, but got 1. | ||
249 | this.copyPageUrl(menu); | ||
250 | this.goToHomePage(menu, menuInfo); | ||
251 | this.openInBrowser(menu, menuInfo); | ||
252 | |||
253 | return menu; | ||
254 | } | ||
255 | |||
256 | /** | ||
257 | * Builds a menu applicable to a text field. | ||
258 | */ | ||
259 | buildMenuForText( | ||
260 | menuInfo: Electron.ContextMenuParams, | ||
261 | ): Electron.CrossProcessExports.Menu { | ||
262 | const menu = new Menu(); | ||
263 | |||
264 | this.addSearchItems(menu, menuInfo); | ||
265 | this.addCopy(menu, menuInfo); | ||
266 | this.addInspectElement(menu, menuInfo); | ||
267 | // @ts-expect-error Expected 1 arguments, but got 2. | ||
268 | this.processMenu(menu, menuInfo); | ||
269 | |||
270 | this.addSeparator(menu); | ||
271 | this.goBack(menu); | ||
272 | this.goForward(menu); | ||
273 | this.copyPageUrl(menu, menuInfo); | ||
274 | this.goToHomePage(menu, menuInfo); | ||
275 | this.openInBrowser(menu, menuInfo); | ||
276 | |||
277 | return menu; | ||
278 | } | ||
279 | |||
280 | /** | ||
281 | * Builds a menu applicable to an image. | ||
282 | * | ||
283 | * @return {Menu} The `Menu` | ||
284 | */ | ||
285 | buildMenuForImage( | ||
286 | menuInfo: Electron.ContextMenuParams, | ||
287 | ): Electron.CrossProcessExports.Menu { | ||
288 | const menu = new Menu(); | ||
289 | |||
290 | if (this.isSrcUrlValid(menuInfo)) { | ||
291 | this.addImageItems(menu, menuInfo); | ||
292 | } | ||
293 | this.addInspectElement(menu, menuInfo); | ||
294 | // @ts-expect-error Expected 1 arguments, but got 2. | ||
295 | this.processMenu(menu, menuInfo); | ||
296 | |||
297 | return menu; | ||
298 | } | ||
299 | |||
300 | /** | ||
301 | * Checks if the current text selection contains a single misspelled word and | ||
302 | * if so, adds suggested spellings as individual menu items. | ||
303 | */ | ||
304 | addSpellingItems( | ||
305 | menu: Electron.CrossProcessExports.Menu, | ||
306 | menuInfo: Electron.ContextMenuParams, | ||
307 | ) { | ||
308 | const webContents = this.getWebContents(); | ||
309 | // Add each spelling suggestion | ||
310 | for (const suggestion of menuInfo.dictionarySuggestions) { | ||
311 | menu.append( | ||
312 | new MenuItem({ | ||
313 | label: suggestion, | ||
314 | // eslint-disable-next-line no-loop-func | ||
315 | click: () => webContents.replaceMisspelling(suggestion), | ||
316 | }), | ||
317 | ); | ||
318 | } | ||
319 | |||
320 | // Allow users to add the misspelled word to the dictionary | ||
321 | if (menuInfo.misspelledWord) { | ||
322 | menu.append( | ||
323 | new MenuItem({ | ||
324 | label: this.stringTable.addToDictionary(), | ||
325 | click: () => | ||
326 | webContents.session.addWordToSpellCheckerDictionary( | ||
327 | menuInfo.misspelledWord, | ||
328 | ), | ||
329 | }), | ||
330 | ); | ||
331 | } | ||
332 | |||
333 | return menu; | ||
334 | } | ||
335 | |||
336 | /** | ||
337 | * Adds search-related menu items. | ||
338 | */ | ||
339 | addSearchItems( | ||
340 | menu: Electron.CrossProcessExports.Menu, | ||
341 | menuInfo: Electron.ContextMenuParams, | ||
342 | ) { | ||
343 | if (!menuInfo.selectionText || menuInfo.selectionText.length === 0) { | ||
344 | return menu; | ||
345 | } | ||
346 | |||
347 | const match = matchesWord(menuInfo.selectionText); | ||
348 | if (!match || match.length === 0) { | ||
349 | return menu; | ||
350 | } | ||
351 | |||
352 | if (isMac) { | ||
353 | const webContents = this.getWebContents(); | ||
354 | |||
355 | const lookUpDefinition = new MenuItem({ | ||
356 | label: this.stringTable.lookUpDefinition({ | ||
357 | word: menuInfo.selectionText.trim(), | ||
358 | }), | ||
359 | click: () => webContents.showDefinitionForSelection(), | ||
360 | }); | ||
361 | |||
362 | menu.append(lookUpDefinition); | ||
363 | } | ||
364 | |||
365 | const search = new MenuItem({ | ||
366 | label: this.stringTable.searchWith({ | ||
367 | // @ts-expect-error Property 'searchEngine' does not exist on type 'ContextMenuParams'. | ||
368 | searchEngine: SEARCH_ENGINE_NAMES[menuInfo.searchEngine], | ||
369 | }), | ||
370 | click: () => { | ||
371 | // @ts-expect-error Property 'searchEngine' does not exist on type 'ContextMenuParams'. | ||
372 | const url = SEARCH_ENGINE_URLS[menuInfo.searchEngine]({ | ||
373 | searchTerm: encodeURIComponent(menuInfo.selectionText), | ||
374 | }); | ||
375 | openExternalUrl(url, true); | ||
376 | }, | ||
377 | }); | ||
378 | |||
379 | menu.append(search); | ||
380 | this.addSeparator(menu); | ||
381 | |||
382 | return menu; | ||
383 | } | ||
384 | |||
385 | isSrcUrlValid(menuInfo: Electron.ContextMenuParams) { | ||
386 | return menuInfo.srcURL && menuInfo.srcURL.length > 0; | ||
387 | } | ||
388 | |||
389 | /** | ||
390 | * Adds "Copy Image" and "Copy Image URL" items when `src` is valid. | ||
391 | */ | ||
392 | addImageItems( | ||
393 | menu: Electron.CrossProcessExports.Menu, | ||
394 | menuInfo: Electron.ContextMenuParams, | ||
395 | ) { | ||
396 | const copyImage = new MenuItem({ | ||
397 | label: this.stringTable.copyImage(), | ||
398 | click: () => { | ||
399 | const result = this.convertImageToBase64( | ||
400 | menuInfo.srcURL, | ||
401 | (dataURL: string) => | ||
402 | clipboard.writeImage(nativeImage.createFromDataURL(dataURL)), | ||
403 | ); | ||
404 | |||
405 | this._sendNotificationOnClipboardEvent( | ||
406 | // @ts-expect-error Property 'clipboardNotifications' does not exist on type 'ContextMenuParams'. | ||
407 | menuInfo.clipboardNotifications, | ||
408 | () => `Image copied from URL: ${menuInfo.srcURL}`, | ||
409 | ); | ||
410 | return result; | ||
411 | }, | ||
412 | }); | ||
413 | |||
414 | menu.append(copyImage); | ||
415 | |||
416 | const copyImageUrl = new MenuItem({ | ||
417 | label: this.stringTable.copyImageUrl(), | ||
418 | click: () => { | ||
419 | const result = clipboard.writeText(menuInfo.srcURL); | ||
420 | this._sendNotificationOnClipboardEvent( | ||
421 | // @ts-expect-error Property 'clipboardNotifications' does not exist on type 'ContextMenuParams'. | ||
422 | menuInfo.clipboardNotifications, | ||
423 | () => `Image URL copied: ${menuInfo.srcURL}`, | ||
424 | ); | ||
425 | return result; | ||
426 | }, | ||
427 | }); | ||
428 | |||
429 | menu.append(copyImageUrl); | ||
430 | |||
431 | // TODO: This doesn't seem to work on linux, so, limiting to Mac for now | ||
432 | if (isMac && menuInfo.srcURL.startsWith('blob:')) { | ||
433 | const downloadImage = new MenuItem({ | ||
434 | label: this.stringTable.downloadImage(), | ||
435 | click: () => { | ||
436 | const urlWithoutBlob = menuInfo.srcURL.slice(5); | ||
437 | this.convertImageToBase64(menuInfo.srcURL, (dataURL: any) => { | ||
438 | const url = new window.URL(urlWithoutBlob); | ||
439 | const fileName = url.pathname.slice(1); | ||
440 | ipcRenderer.send('download-file', { | ||
441 | content: dataURL, | ||
442 | fileOptions: { | ||
443 | name: fileName, | ||
444 | mime: 'image/png', | ||
445 | }, | ||
446 | }); | ||
447 | }); | ||
448 | this._sendNotificationOnClipboardEvent( | ||
449 | // @ts-expect-error Property 'clipboardNotifications' does not exist on type 'ContextMenuParams'. | ||
450 | menuInfo.clipboardNotifications, | ||
451 | () => `Image downloaded: ${urlWithoutBlob}`, | ||
452 | ); | ||
453 | }, | ||
454 | }); | ||
455 | |||
456 | menu.append(downloadImage); | ||
457 | } | ||
458 | |||
459 | return menu; | ||
460 | } | ||
461 | |||
462 | /** | ||
463 | * Adds the Cut menu item | ||
464 | */ | ||
465 | addCut( | ||
466 | menu: Electron.CrossProcessExports.Menu, | ||
467 | menuInfo: Electron.ContextMenuParams, | ||
468 | ) { | ||
469 | const webContents = this.getWebContents(); | ||
470 | menu.append( | ||
471 | new MenuItem({ | ||
472 | label: this.stringTable.cut(), | ||
473 | accelerator: `${cmdOrCtrlShortcutKey()}+X`, | ||
474 | enabled: menuInfo.editFlags.canCut, | ||
475 | click: () => webContents.cut(), | ||
476 | }), | ||
477 | ); | ||
478 | |||
479 | return menu; | ||
480 | } | ||
481 | |||
482 | /** | ||
483 | * Adds the Copy menu item. | ||
484 | */ | ||
485 | addCopy( | ||
486 | menu: Electron.CrossProcessExports.Menu, | ||
487 | menuInfo: Electron.ContextMenuParams, | ||
488 | ) { | ||
489 | const webContents = this.getWebContents(); | ||
490 | menu.append( | ||
491 | new MenuItem({ | ||
492 | label: this.stringTable.copy(), | ||
493 | accelerator: `${cmdOrCtrlShortcutKey()}+C`, | ||
494 | enabled: menuInfo.editFlags.canCopy, | ||
495 | click: () => webContents.copy(), | ||
496 | }), | ||
497 | ); | ||
498 | |||
499 | return menu; | ||
500 | } | ||
501 | |||
502 | /** | ||
503 | * Adds the Paste menu item. | ||
504 | */ | ||
505 | addPaste( | ||
506 | menu: Electron.CrossProcessExports.Menu, | ||
507 | menuInfo: Electron.ContextMenuParams, | ||
508 | ) { | ||
509 | const webContents = this.getWebContents(); | ||
510 | menu.append( | ||
511 | new MenuItem({ | ||
512 | label: this.stringTable.paste(), | ||
513 | accelerator: `${cmdOrCtrlShortcutKey()}+V`, | ||
514 | enabled: menuInfo.editFlags.canPaste, | ||
515 | click: () => webContents.paste(), | ||
516 | }), | ||
517 | ); | ||
518 | |||
519 | return menu; | ||
520 | } | ||
521 | |||
522 | addPastePlain( | ||
523 | menu: Electron.CrossProcessExports.Menu, | ||
524 | menuInfo: Electron.ContextMenuParams, | ||
525 | ) { | ||
526 | if ( | ||
527 | menuInfo.editFlags.canPaste && | ||
528 | !menuInfo.linkText && | ||
529 | !menuInfo.hasImageContents | ||
530 | ) { | ||
531 | const webContents = this.getWebContents(); | ||
532 | menu.append( | ||
533 | new MenuItem({ | ||
534 | label: this.stringTable.pasteAndMatchStyle(), | ||
535 | accelerator: `${cmdOrCtrlShortcutKey()}+Shift+V`, | ||
536 | click: () => webContents.pasteAndMatchStyle(), | ||
537 | }), | ||
538 | ); | ||
539 | } | ||
540 | } | ||
541 | |||
542 | /** | ||
543 | * Adds a separator item. | ||
544 | */ | ||
545 | addSeparator(menu: Electron.CrossProcessExports.Menu) { | ||
546 | menu.append(new MenuItem({ type: 'separator' })); | ||
547 | return menu; | ||
548 | } | ||
549 | |||
550 | /** | ||
551 | * Adds the "Inspect Element" menu item. | ||
552 | */ | ||
553 | addInspectElement( | ||
554 | menu: Electron.CrossProcessExports.Menu, | ||
555 | menuInfo: Electron.ContextMenuParams, | ||
556 | needsSeparator = true, | ||
557 | ) { | ||
558 | const webContents = this.getWebContents(); | ||
559 | if (!this.debugMode) return menu; | ||
560 | if (needsSeparator) this.addSeparator(menu); | ||
561 | |||
562 | const inspect = new MenuItem({ | ||
563 | label: this.stringTable.inspectElement(), | ||
564 | click: () => webContents.inspectElement(menuInfo.x, menuInfo.y), | ||
565 | }); | ||
566 | |||
567 | menu.append(inspect); | ||
568 | return menu; | ||
569 | } | ||
570 | |||
571 | /** | ||
572 | * Converts an image to a base-64 encoded string. | ||
573 | * | ||
574 | * @param {String} url The image URL | ||
575 | * @param {Function} callback A callback that will be invoked with the result | ||
576 | * @param {String} outputFormat The image format to use, defaults to 'image/png' | ||
577 | */ | ||
578 | convertImageToBase64( | ||
579 | url: string, | ||
580 | callback: { | ||
581 | (dataURL: any): void; | ||
582 | (dataURL: any): void; | ||
583 | (arg0: string): void; | ||
584 | }, | ||
585 | outputFormat: string = 'image/png', | ||
586 | ) { | ||
587 | let canvas: HTMLCanvasElement | null = document.createElement('canvas'); | ||
588 | const ctx = canvas.getContext('2d'); | ||
589 | const img = new Image(); | ||
590 | img.crossOrigin = 'Anonymous'; | ||
591 | |||
592 | img.addEventListener('load', () => { | ||
593 | if (canvas) { | ||
594 | canvas.height = img.height; | ||
595 | canvas.width = img.width; | ||
596 | ctx?.drawImage(img, 0, 0); | ||
597 | |||
598 | const dataURL = canvas.toDataURL(outputFormat); | ||
599 | canvas = null; | ||
600 | callback(dataURL); | ||
601 | } | ||
602 | }); | ||
603 | |||
604 | img.src = url; | ||
605 | } | ||
606 | |||
607 | /** | ||
608 | * Adds the 'go back' menu item | ||
609 | */ | ||
610 | goBack(menu: Electron.CrossProcessExports.Menu) { | ||
611 | const webContents = this.getWebContents(); | ||
612 | menu.append( | ||
613 | new MenuItem({ | ||
614 | label: this.stringTable.goBack(), | ||
615 | accelerator: `${cmdOrCtrlShortcutKey()}+left`, | ||
616 | enabled: webContents.canGoBack(), | ||
617 | click: () => webContents.goBack(), | ||
618 | }), | ||
619 | ); | ||
620 | |||
621 | return menu; | ||
622 | } | ||
623 | |||
624 | /** | ||
625 | * Adds the 'go forward' menu item | ||
626 | */ | ||
627 | goForward(menu: Electron.CrossProcessExports.Menu) { | ||
628 | const webContents = this.getWebContents(); | ||
629 | menu.append( | ||
630 | new MenuItem({ | ||
631 | label: this.stringTable.goForward(), | ||
632 | accelerator: `${cmdOrCtrlShortcutKey()}+right`, | ||
633 | enabled: webContents.canGoForward(), | ||
634 | click: () => webContents.goForward(), | ||
635 | }), | ||
636 | ); | ||
637 | |||
638 | return menu; | ||
639 | } | ||
640 | |||
641 | /** | ||
642 | * Adds the 'copy page url' menu item. | ||
643 | */ | ||
644 | copyPageUrl( | ||
645 | menu: Electron.CrossProcessExports.Menu, | ||
646 | menuInfo: Electron.ContextMenuParams, | ||
647 | ) { | ||
648 | menu.append( | ||
649 | new MenuItem({ | ||
650 | label: this.stringTable.copyPageUrl(), | ||
651 | enabled: true, | ||
652 | click: () => { | ||
653 | clipboard.writeText(window.location.href); | ||
654 | this._sendNotificationOnClipboardEvent( | ||
655 | // @ts-expect-error Property 'clipboardNotifications' does not exist on type 'ContextMenuParams'. | ||
656 | menuInfo?.clipboardNotifications, | ||
657 | () => `Page URL copied: ${window.location.href}`, | ||
658 | ); | ||
659 | }, | ||
660 | }), | ||
661 | ); | ||
662 | |||
663 | return menu; | ||
664 | } | ||
665 | |||
666 | /** | ||
667 | * Adds the 'go to home' menu item. | ||
668 | */ | ||
669 | goToHomePage( | ||
670 | menu: Electron.CrossProcessExports.Menu, | ||
671 | menuInfo: Electron.ContextMenuParams, | ||
672 | ) { | ||
673 | const baseURL = new window.URL(menuInfo.pageURL); | ||
674 | menu.append( | ||
675 | new MenuItem({ | ||
676 | label: this.stringTable.goToHomePage(), | ||
677 | accelerator: `${cmdOrCtrlShortcutKey()}+Home`, | ||
678 | enabled: true, | ||
679 | click: () => { | ||
680 | // webContents.loadURL(baseURL.origin); | ||
681 | window.location.href = baseURL.origin; | ||
682 | }, | ||
683 | }), | ||
684 | ); | ||
685 | |||
686 | return menu; | ||
687 | } | ||
688 | |||
689 | /** | ||
690 | * Adds the 'open in browser' menu item. | ||
691 | */ | ||
692 | openInBrowser( | ||
693 | menu: Electron.CrossProcessExports.Menu, | ||
694 | menuInfo: Electron.ContextMenuParams, | ||
695 | ) { | ||
696 | menu.append( | ||
697 | new MenuItem({ | ||
698 | label: this.stringTable.openInBrowser(), | ||
699 | enabled: true, | ||
700 | click: () => { | ||
701 | openExternalUrl(menuInfo.pageURL, true); | ||
702 | }, | ||
703 | }), | ||
704 | ); | ||
705 | |||
706 | return menu; | ||
707 | } | ||
708 | |||
709 | _sendNotificationOnClipboardEvent( | ||
710 | isDisabled: boolean, | ||
711 | notificationText: () => string, | ||
712 | ) { | ||
713 | if (isDisabled) { | ||
714 | return; | ||
715 | } | ||
716 | // eslint-disable-next-line no-new | ||
717 | new window.Notification('Data copied into Clipboard', { | ||
718 | body: notificationText(), | ||
719 | }); | ||
720 | } | ||
721 | } | ||