-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
app-window.ts
525 lines (452 loc) · 14.6 KB
/
app-window.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
import {
Menu,
app,
dialog,
BrowserWindow,
autoUpdater,
nativeTheme,
} from 'electron'
import { shell } from '../lib/app-shell'
import { Emitter, Disposable } from 'event-kit'
import { encodePathAsUrl } from '../lib/path'
import {
getWindowState,
registerWindowStateChangedEvents,
} from '../lib/window-state'
import { MenuEvent } from './menu'
import { URLActionType } from '../lib/parse-app-url'
import { ILaunchStats } from '../lib/stats'
import { menuFromElectronMenu } from '../models/app-menu'
import { now } from './now'
import * as path from 'path'
import windowStateKeeper from 'electron-window-state'
import * as ipcMain from './ipc-main'
import * as ipcWebContents from './ipc-webcontents'
import {
installNotificationCallback,
terminateDesktopNotifications,
} from './notifications'
import { addTrustedIPCSender } from './trusted-ipc-sender'
import { getUpdaterGUID } from '../lib/get-updater-guid'
export class AppWindow {
private window: Electron.BrowserWindow
private emitter = new Emitter()
private _loadTime: number | null = null
private _rendererReadyTime: number | null = null
private isDownloadingUpdate: boolean = false
private minWidth = 960
private minHeight = 660
// See https://github.com/desktop/desktop/pull/11162
private shouldMaximizeOnShow = false
public constructor() {
const savedWindowState = windowStateKeeper({
defaultWidth: this.minWidth,
defaultHeight: this.minHeight,
maximize: false,
})
const windowOptions: Electron.BrowserWindowConstructorOptions = {
x: savedWindowState.x,
y: savedWindowState.y,
width: savedWindowState.width,
height: savedWindowState.height,
minWidth: this.minWidth,
minHeight: this.minHeight,
show: false,
// This fixes subpixel aliasing on Windows
// See https://github.com/atom/atom/commit/683bef5b9d133cb194b476938c77cc07fd05b972
backgroundColor: '#fff',
webPreferences: {
// Disable auxclick event
// See https://developers.google.com/web/updates/2016/10/auxclick
disableBlinkFeatures: 'Auxclick',
nodeIntegration: true,
spellcheck: true,
contextIsolation: false,
},
acceptFirstMouse: true,
}
if (__DARWIN__) {
windowOptions.titleBarStyle = 'hidden'
} else if (__WIN32__) {
windowOptions.frame = false
} else if (__LINUX__) {
windowOptions.icon = path.join(__dirname, 'static', 'icon-logo.png')
}
this.window = new BrowserWindow(windowOptions)
addTrustedIPCSender(this.window.webContents)
installNotificationCallback(this.window)
savedWindowState.manage(this.window)
this.shouldMaximizeOnShow = savedWindowState.isMaximized
let quitting = false
let quittingEvenIfUpdating = false
app.on('before-quit', () => {
quitting = true
})
ipcMain.on('will-quit', event => {
quitting = true
event.returnValue = true
})
ipcMain.on('will-quit-even-if-updating', event => {
quitting = true
quittingEvenIfUpdating = true
event.returnValue = true
})
ipcMain.on('cancel-quitting', event => {
quitting = false
quittingEvenIfUpdating = false
event.returnValue = true
})
this.window.on('close', e => {
// On macOS, closing the window doesn't mean the app is quitting. If the
// app is updating, we will prevent the window from closing only when the
// app is also quitting.
if (
(!__DARWIN__ || quitting) &&
!quittingEvenIfUpdating &&
this.isDownloadingUpdate
) {
e.preventDefault()
ipcWebContents.send(this.window.webContents, 'show-installing-update')
// Make sure the window is visible, so the user can see why we're
// preventing the app from quitting. This is important on macOS, where
// the window could be hidden/closed when the user tries to quit.
// It could also happen on Windows if the user quits the app from the
// task bar while it's in the background.
this.show()
return
}
// on macOS, when the user closes the window we really just hide it. This
// lets us activate quickly and keep all our interesting logic in the
// renderer.
if (__DARWIN__ && !quitting) {
e.preventDefault()
// https://github.com/desktop/desktop/issues/12838
if (this.window.isFullScreen()) {
this.window.setFullScreen(false)
this.window.once('leave-full-screen', () => this.window.hide())
} else {
this.window.hide()
}
return
}
nativeTheme.removeAllListeners()
autoUpdater.removeAllListeners()
terminateDesktopNotifications()
})
if (__WIN32__) {
// workaround for known issue with fullscreen-ing the app and restoring
// is that some Chromium API reports the incorrect bounds, so that it
// will leave a small space at the top of the screen on every other
// maximize
//
// adapted from https://github.com/electron/electron/issues/12971#issuecomment-403956396
//
// can be tidied up once https://github.com/electron/electron/issues/12971
// has been confirmed as resolved
this.window.once('ready-to-show', () => {
this.window.on('unmaximize', () => {
setTimeout(() => {
const bounds = this.window.getBounds()
bounds.width += 1
this.window.setBounds(bounds)
bounds.width -= 1
this.window.setBounds(bounds)
}, 5)
})
})
}
}
public load() {
let startLoad = 0
// We only listen for the first of the loading events to avoid a bug in
// Electron/Chromium where they can sometimes fire more than once. See
// See
// https://github.com/desktop/desktop/pull/513#issuecomment-253028277. This
// shouldn't really matter as in production builds loading _should_ only
// happen once.
this.window.webContents.once('did-start-loading', () => {
this._rendererReadyTime = null
this._loadTime = null
startLoad = now()
})
this.window.webContents.once('did-finish-load', () => {
if (process.env.NODE_ENV === 'development') {
this.window.webContents.openDevTools()
}
this._loadTime = now() - startLoad
this.maybeEmitDidLoad()
})
this.window.webContents.on('did-finish-load', () => {
this.window.webContents.setVisualZoomLevelLimits(1, 1)
})
this.window.webContents.on('did-fail-load', () => {
this.window.webContents.openDevTools()
this.window.show()
})
// TODO: This should be scoped by the window.
ipcMain.once('renderer-ready', (_, readyTime) => {
this._rendererReadyTime = readyTime
this.maybeEmitDidLoad()
})
this.window.on('focus', () =>
ipcWebContents.send(this.window.webContents, 'focus')
)
this.window.on('blur', () =>
ipcWebContents.send(this.window.webContents, 'blur')
)
registerWindowStateChangedEvents(this.window)
this.window.loadURL(encodePathAsUrl(__dirname, 'index.html'))
nativeTheme.addListener('updated', (event: string, userInfo: any) => {
ipcWebContents.send(this.window.webContents, 'native-theme-updated')
})
this.setupAutoUpdater()
}
/**
* Emit the `onDidLoad` event if the page has loaded and the renderer has
* signalled that it's ready.
*/
private maybeEmitDidLoad() {
if (!this.rendererLoaded) {
return
}
this.emitter.emit('did-load', null)
}
/** Is the page loaded and has the renderer signalled it's ready? */
private get rendererLoaded(): boolean {
return !!this.loadTime && !!this.rendererReadyTime
}
public onClosed(fn: () => void) {
this.window.on('closed', fn)
}
/**
* Register a function to call when the window is done loading. At that point
* the page has loaded and the renderer has signalled that it is ready.
*/
public onDidLoad(fn: () => void): Disposable {
return this.emitter.on('did-load', fn)
}
public isMinimized() {
return this.window.isMinimized()
}
/** Is the window currently visible? */
public isVisible() {
return this.window.isVisible()
}
public restore() {
this.window.restore()
}
public isFocused() {
return this.window.isFocused()
}
public focus() {
this.window.focus()
}
/** Selects all the windows web contents */
public selectAllWindowContents() {
this.window.webContents.selectAll()
}
/** Show the window. */
public show() {
this.window.show()
if (this.shouldMaximizeOnShow) {
// Only maximize the window the first time it's shown, not every time.
// Otherwise, it causes the problem described in desktop/desktop#11590
this.shouldMaximizeOnShow = false
this.window.maximize()
}
}
/** Send the menu event to the renderer. */
public sendMenuEvent(name: MenuEvent) {
this.show()
ipcWebContents.send(this.window.webContents, 'menu-event', name)
}
/** Send the URL action to the renderer. */
public sendURLAction(action: URLActionType) {
this.show()
ipcWebContents.send(this.window.webContents, 'url-action', action)
}
/** Send the app launch timing stats to the renderer. */
public sendLaunchTimingStats(stats: ILaunchStats) {
ipcWebContents.send(this.window.webContents, 'launch-timing-stats', stats)
}
/** Send the app menu to the renderer. */
public sendAppMenu() {
const appMenu = Menu.getApplicationMenu()
if (appMenu) {
const menu = menuFromElectronMenu(appMenu)
ipcWebContents.send(this.window.webContents, 'app-menu', menu)
}
}
/** Handle when a modal dialog is opened. */
public dialogDidOpen() {
if (this.window.isFocused()) {
// No additional notifications are needed.
return
}
// Care is taken to mimic OS dialog behaviors.
if (__DARWIN__) {
// macOS beeps when a modal dialog is opened.
shell.beep()
// See https://developer.apple.com/documentation/appkit/nsapplication/1428358-requestuserattention
// "If the inactive app presents a modal panel, this method will be invoked with NSCriticalRequest
// automatically. The modal panel is not brought to the front for an inactive app."
// NOTE: flashFrame() uses the 'informational' level, so we need to explicitly bounce the dock
// with the 'critical' level in order to that described behavior.
app.dock.bounce('critical')
} else {
// See https://learn.microsoft.com/en-us/windows/win32/uxguide/winenv-taskbar#taskbar-button-flashing
// "If an inactive program requires immediate attention,
// flash its taskbar button to draw attention and leave it highlighted."
// It advises not to beep.
this.window.once('focus', () => this.window.flashFrame(false))
this.window.flashFrame(true)
}
}
/** Send a certificate error to the renderer. */
public sendCertificateError(
certificate: Electron.Certificate,
error: string,
url: string
) {
ipcWebContents.send(
this.window.webContents,
'certificate-error',
certificate,
error,
url
)
}
public showCertificateTrustDialog(
certificate: Electron.Certificate,
message: string
) {
// The Electron type definitions don't include `showCertificateTrustDialog`
// yet.
const d = dialog as any
d.showCertificateTrustDialog(
this.window,
{ certificate, message },
() => {}
)
}
/**
* Get the time (in milliseconds) spent loading the page.
*
* This will be `null` until `onDidLoad` is called.
*/
public get loadTime(): number | null {
return this._loadTime
}
/**
* Get the time (in milliseconds) elapsed from the renderer being loaded to it
* signaling it was ready.
*
* This will be `null` until `onDidLoad` is called.
*/
public get rendererReadyTime(): number | null {
return this._rendererReadyTime
}
public destroy() {
this.window.destroy()
}
public setupAutoUpdater() {
autoUpdater.on('error', (error: Error) => {
this.isDownloadingUpdate = false
ipcWebContents.send(this.window.webContents, 'auto-updater-error', error)
})
autoUpdater.on('checking-for-update', () => {
this.isDownloadingUpdate = false
ipcWebContents.send(
this.window.webContents,
'auto-updater-checking-for-update'
)
})
autoUpdater.on('update-available', () => {
this.isDownloadingUpdate = true
ipcWebContents.send(
this.window.webContents,
'auto-updater-update-available'
)
})
autoUpdater.on('update-not-available', () => {
this.isDownloadingUpdate = false
ipcWebContents.send(
this.window.webContents,
'auto-updater-update-not-available'
)
})
autoUpdater.on('update-downloaded', () => {
this.isDownloadingUpdate = false
ipcWebContents.send(
this.window.webContents,
'auto-updater-update-downloaded'
)
})
}
public async checkForUpdates(url: string) {
try {
autoUpdater.setFeedURL({ url: await trySetUpdaterGuid(url) })
autoUpdater.checkForUpdates()
} catch (e) {
return e
}
return undefined
}
public quitAndInstallUpdate() {
autoUpdater.quitAndInstall()
}
public minimizeWindow() {
this.window.minimize()
}
public maximizeWindow() {
this.window.maximize()
}
public unmaximizeWindow() {
this.window.unmaximize()
}
public closeWindow() {
this.window.close()
}
public isMaximized() {
return this.window.isMaximized()
}
public getCurrentWindowState() {
return getWindowState(this.window)
}
public getCurrentWindowZoomFactor() {
return this.window.webContents.zoomFactor
}
public setWindowZoomFactor(zoomFactor: number) {
this.window.webContents.zoomFactor = zoomFactor
}
/**
* Method to show the save dialog and return the first file path it returns.
*/
public async showSaveDialog(options: Electron.SaveDialogOptions) {
const { canceled, filePath } = await dialog.showSaveDialog(
this.window,
options
)
return !canceled && filePath !== undefined ? filePath : null
}
/**
* Method to show the open dialog and return the first file path it returns.
*/
public async showOpenDialog(options: Electron.OpenDialogOptions) {
const { filePaths } = await dialog.showOpenDialog(this.window, options)
return filePaths.length > 0 ? filePaths[0] : null
}
}
const trySetUpdaterGuid = async (url: string) => {
try {
const id = await getUpdaterGUID()
if (!id) {
return url
}
const parsed = new URL(url)
parsed.searchParams.set('guid', id)
return parsed.toString()
} catch (e) {
return url
}
}