index.js
23.1 KB
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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
import {BrowserWindow, Menu, app, dialog, ipcMain, shell, systemPreferences} from 'electron';
import * as remote from '@electron/remote/main';
import fs from 'fs-extra';
import path from 'path';
import {URL} from 'url';
import {promisify} from 'util';
import argv from './argv';
import {getFilterForExtension} from './FileFilters';
import telemetry from './OpenblockDesktopTelemetry';
import Updater from './OpenblockDesktopUpdater';
import DesktopLink from './OpenblockDesktopLink.js';
import MacOSMenu from './MacOSMenu';
import log from '../common/log.js';
import {productName, version} from '../../package.json';
import {v4 as uuidv4} from 'uuid';
import ElectronStore from 'electron-store';
import formatMessage from 'format-message';
import locales from 'openblock-l10n/locales/desktop-msgs';
const storage = new ElectronStore();
const desktopLink = new DesktopLink();
formatMessage.setup({translations: locales});
// suppress deprecation warning; this will be the default in Electron 9
app.allowRendererProcessReuse = true;
// allow connect to localhost
app.commandLine.appendSwitch('allow-insecure-localhost', 'true');
// enable gpu and ignore gpu blacklist
app.commandLine.hasSwitch('enable-gpu');
app.commandLine.hasSwitch('ignore-gpu-blacklist');
telemetry.appWasOpened();
const defaultSize = {width: 1620, height: 900};
const isDevelopment = process.env.NODE_ENV !== 'production';
const devToolKey = ((process.platform === 'darwin') ?
{ // macOS: command+option+i
alt: true, // option
control: false,
meta: true, // command
shift: false,
code: 'KeyI'
} : { // Windows: control+shift+i
alt: false,
control: true,
meta: false, // Windows key
shift: true,
code: 'KeyI'
}
);
// global window references prevent them from being garbage-collected
const _windows = {};
// enable connecting to Scratch Link even if we DNS / Internet access is not available
// this must happen BEFORE the app ready event!
app.commandLine.appendSwitch('host-resolver-rules', 'MAP device-manager.scratch.mit.edu 127.0.0.1');
const displayPermissionDeniedWarning = (browserWindow, permissionType) => {
let title;
let message;
switch (permissionType) {
case 'camera':
title = formatMessage({
id: 'index.cameraPermissionDeniedTitle',
default: 'Camera Permission Denied',
description: 'prompt for camera permission denied'
});
message = formatMessage({
id: 'index.cameraPermissionDeniedMessage',
default: 'Permission to use the camera has been denied. ' +
'OpenBlock will not be able to take a photo or use video sensing blocks.',
description: 'message for camera permission denied'
});
break;
case 'microphone':
title = formatMessage({
id: 'index.microphonePermissionDeniedTitle',
default: 'Microphone Permission Denied',
description: 'prompt for microphone permission denied'
});
message = formatMessage({
id: 'index.microphonePermissionDeniedMessage',
default: 'Permission to use the microphone has been denied. ' +
'OpenBlock will not be able to record sounds or detect loudness.',
description: 'message for microphone permission denied'
});
break;
default: // shouldn't ever happen...
title = formatMessage({
id: 'index.permissionDeniedTitle',
default: 'Permission Denied',
description: 'prompt for permission denied'
});
message = formatMessage({
id: 'index.permissionDeniedMessage',
default: 'A permission has been denied.',
description: 'message for permission denied'
});
}
let instructions;
switch (process.platform) {
case 'darwin':
instructions = formatMessage({
id: 'index.darwinPermissionDeniedInstructions',
default: 'To change OpenBlock permissions, please check "Security & Privacy" in System Preferences.',
description: 'prompt for fix darwin permission denied instructions'
});
break;
default:
instructions = formatMessage({
id: 'index.permissionDeniedInstructions',
default: 'To change OpenBlock permissions, please check your system settings and restart OpenBlock.',
description: 'prompt for fix permission denied instructions'
});
break;
}
message = `${message}\n\n${instructions}`;
dialog.showMessageBox(browserWindow, {type: 'warning', title, message});
};
/**
* Build an absolute URL from a relative one, optionally adding search query parameters.
* The base of the URL will depend on whether or not the application is running in development mode.
* @param {string} url - the relative URL, like 'index.html'
* @param {*} search - the optional "search" parameters (the part of the URL after '?'), like "route=about"
* @returns {string} - an absolute URL as a string
*/
const makeFullUrl = (url, search = null) => {
const baseUrl = (isDevelopment ?
`http://localhost:${process.env.ELECTRON_WEBPACK_WDS_PORT}/` :
`file://${__dirname}/`
);
const fullUrl = new URL(url, baseUrl);
if (search) {
fullUrl.search = search; // automatically percent-encodes anything that needs it
}
return fullUrl.toString();
};
/**
* Prompt in a platform-specific way for permission to access the microphone or camera, if Electron supports doing so.
* Any application-level checks, such as whether or not a particular frame or document should be allowed to ask,
* should be done before calling this function.
* This function may return a Promise!
*
* @param {string} mediaType - one of Electron's media types, like 'microphone' or 'camera'
* @returns {boolean|Promise.<boolean>} - true if permission granted, false otherwise.
*/
const askForMediaAccess = mediaType => {
if (systemPreferences.askForMediaAccess) {
// Electron currently only implements this on macOS
// This returns a Promise
return systemPreferences.askForMediaAccess(mediaType);
}
// For other platforms we can't reasonably do anything other than assume we have access.
return true;
};
const handlePermissionRequest = async (webContents, permission, callback, details) => {
if (webContents !== _windows.main.webContents) {
// deny: request came from somewhere other than the main window's web contents
return callback(false);
}
if (!details.isMainFrame) {
// deny: request came from a subframe of the main window, not the main frame
return callback(false);
}
if (permission !== 'media') {
// deny: request is for some other kind of access like notifications or pointerLock
return callback(false);
}
const requiredBase = makeFullUrl('');
if (details.requestingUrl.indexOf(requiredBase) !== 0) {
// deny: request came from a URL outside of our "sandbox"
return callback(false);
}
let askForMicrophone = false;
let askForCamera = false;
for (const mediaType of details.mediaTypes) {
switch (mediaType) {
case 'audio':
askForMicrophone = true;
break;
case 'video':
askForCamera = true;
break;
default:
// deny: unhandled media type
return callback(false);
}
}
const parentWindow = _windows.main; // if we ever allow media in non-main windows we'll also need to change this
if (askForMicrophone) {
const microphoneResult = await askForMediaAccess('microphone');
if (!microphoneResult) {
displayPermissionDeniedWarning(parentWindow, 'microphone');
return callback(false);
}
}
if (askForCamera) {
const cameraResult = await askForMediaAccess('camera');
if (!cameraResult) {
displayPermissionDeniedWarning(parentWindow, 'camera');
return callback(false);
}
}
return callback(true);
};
const createWindow = ({search = null, url = 'index.html', ...browserWindowOptions}) => {
const window = new BrowserWindow({
useContentSize: true,
show: false,
webPreferences: {
contextIsolation: false,
nodeIntegration: true
},
...browserWindowOptions
});
const webContents = window.webContents;
webContents.session.setPermissionRequestHandler(handlePermissionRequest);
webContents.on('before-input-event', (event, input) => {
if (input.code === devToolKey.code &&
input.alt === devToolKey.alt &&
input.control === devToolKey.control &&
input.meta === devToolKey.meta &&
input.shift === devToolKey.shift &&
input.type === 'keyDown' &&
!input.isAutoRepeat &&
!input.isComposing) {
event.preventDefault();
webContents.openDevTools({mode: 'detach', activate: true});
}
});
webContents.on('new-window', (event, newWindowUrl) => {
shell.openExternal(newWindowUrl);
event.preventDefault();
});
const fullUrl = makeFullUrl(url, search);
window.loadURL(fullUrl);
window.once('ready-to-show', () => {
webContents.send('ready-to-show');
});
return window;
};
const createAboutWindow = () => {
const window = createWindow({
width: 400,
height: 400,
parent: _windows.main,
search: 'route=about',
title: `About ${productName}`
});
return window;
};
const createLicenseWindow = () => {
const window = createWindow({
width: _windows.main.width * 0.8,
height: _windows.main.height * 0.8,
parent: _windows.main,
search: 'route=license',
title: `${productName} License`
});
return window;
};
const createPrivacyWindow = () => {
const window = createWindow({
width: _windows.main.width * 0.8,
height: _windows.main.height * 0.8,
parent: _windows.main,
search: 'route=privacy',
title: `${productName} Privacy Policy`
});
return window;
};
const createLoadingWindow = () => {
const window = createWindow({
width: 800,
height: 150,
frame: false,
resizable: false,
transparent: true,
hasShadow: false,
search: 'route=loading',
title: `Loding ${productName} ${version}`
});
window.once('ready-to-show', () => {
window.show();
});
return window;
};
const getIsProjectSave = downloadItem => {
switch (downloadItem.getMimeType()) {
case 'application/x.openblock.ob':
return true;
}
return false;
};
const createMainWindow = () => {
const window = createWindow({
width: defaultSize.width,
height: defaultSize.height,
title: `${productName} ${version}` // something like "Scratch 3.14"
});
const webContents = window.webContents;
const update = new Updater(webContents, desktopLink.resourceServer);
remote.initialize();
remote.enable(webContents);
webContents.session.on('will-download', (willDownloadEvent, downloadItem) => {
const isProjectSave = getIsProjectSave(downloadItem);
const itemPath = downloadItem.getFilename();
const baseName = path.basename(itemPath);
const extName = path.extname(baseName);
const options = {
defaultPath: baseName
};
if (extName) {
const extNameNoDot = extName.replace(/^\./, '');
options.filters = [getFilterForExtension(extNameNoDot)];
}
const userChosenPath = dialog.showSaveDialogSync(window, options);
// this will be falsy if the user canceled the save
if (userChosenPath) {
const userBaseName = path.basename(userChosenPath);
const tempPath = path.join(app.getPath('temp'), userBaseName);
// WARNING: `setSavePath` on this item is only valid during the `will-download` event. Calling the async
// version of `showSaveDialog` means the event will finish before we get here, so `setSavePath` will be
// ignored. For that reason we need to call `showSaveDialogSync` above.
downloadItem.setSavePath(tempPath);
downloadItem.on('done', async (doneEvent, doneState) => {
try {
if (doneState !== 'completed') {
// The download was canceled or interrupted. Cancel the telemetry event and delete the file.
throw new Error(`save ${doneState}`); // "save cancelled" or "save interrupted"
}
await fs.move(tempPath, userChosenPath, {overwrite: true});
if (isProjectSave) {
const newProjectTitle = path.basename(userChosenPath, extName);
webContents.send('setTitleFromSave', {title: newProjectTitle});
// "setTitleFromSave" will set the project title but GUI has already reported the telemetry
// event using the old title. This call lets the telemetry client know that the save was
// actually completed and the event should be committed to the event queue with this new title.
telemetry.projectSaveCompleted(newProjectTitle);
}
} catch (e) {
if (isProjectSave) {
telemetry.projectSaveCanceled();
}
// don't clean up until after the message box to allow troubleshooting / recovery
await dialog.showMessageBox(window, {
type: 'error',
title: formatMessage({
id: 'index.saveFailedTitle',
default: 'Failed to save project',
description: 'Title for save failed'
}),
message: `${formatMessage({
id: 'index.saveFailed',
default: 'Save failed:',
description: 'prompt for save failed'
})}\n${userChosenPath}`,
detail: e.message
});
fs.exists(tempPath).then(exists => {
if (exists) {
fs.unlink(tempPath);
}
});
}
});
} else {
downloadItem.cancel();
if (isProjectSave) {
telemetry.projectSaveCanceled();
}
}
});
webContents.on('will-prevent-unload', ev => {
const choice = dialog.showMessageBoxSync(window, {
title: productName,
type: 'question',
message: formatMessage({
id: 'index.questionLeave',
default: 'Leave Openblock?',
description: 'prompt for leave Openblock'
}),
detail: formatMessage({
id: 'index.questionLeaveDetail',
default: 'Any unsaved changes will be lost.',
description: 'detail prompt for leave Openblock'
}),
buttons: [
formatMessage({
id: 'index.stay',
default: 'Stay',
description: 'Label for stay'
}), formatMessage({
id: 'index.leave',
default: 'Leave',
description: 'Label for leave'
})
],
cancelId: 0, // closing the dialog means "stay"
defaultId: 0 // pressing enter or space without explicitly selecting something means "stay"
});
const shouldQuit = (choice === 1);
if (shouldQuit) {
ev.preventDefault();
}
});
ipcMain.on('loading-completed', () => {
if (!storage.has('userId')) {
storage.set('userId', uuidv4());
}
const userId = storage.get('userId');
webContents.send('setUserId', userId);
webContents.send('setPlatform', process.platform);
update.checkUpdateAtStartup();
});
ipcMain.on('reqeustCheckUpdate', () => {
update.reqeustCheckUpdate();
});
ipcMain.on('reqeustUpdate', () => {
update.reqeustUpdate()
.then(() => {
setTimeout(() => {
console.log(`INFO: App will restart after 3 seconds`);
app.relaunch();
app.exit();
}, 1000 * 3);
})
.catch(err => {
console.error(`ERR!: update failed: ${err}`);
});
});
ipcMain.on('abortUpdate', () => {
update.abortUpdate();
});
return window;
};
if (process.platform === 'darwin') {
const osxMenu = Menu.buildFromTemplate(MacOSMenu(app));
Menu.setApplicationMenu(osxMenu);
} else {
// disable menu for other platforms
Menu.setApplicationMenu(null);
}
// quit application when all windows are closed
app.on('window-all-closed', () => {
app.quit();
});
app.on('will-quit', () => {
telemetry.appWillClose();
});
app.on('activate', () => {
if (_windows.main === null) {
createMainWindow();
}
});
// work around https://github.com/MarshallOfSound/electron-devtools-installer/issues/122
// which seems to be a result of https://github.com/electron/electron/issues/19468
if (process.platform === 'win32') {
const appUserDataPath = app.getPath('userData');
const devToolsExtensionsPath = path.join(appUserDataPath, 'DevTools Extensions');
try {
fs.unlinkSync(devToolsExtensionsPath);
} catch (_) {
// don't complain if the file doesn't exist
}
}
// create main BrowserWindow when electron is ready
app.on('ready', () => {
if (isDevelopment) {
import('electron-devtools-installer').then(importedModule => {
const {default: installExtension, ...devToolsExtensions} = importedModule;
const extensionsToInstall = [
devToolsExtensions.REACT_DEVELOPER_TOOLS,
devToolsExtensions.REACT_PERF,
devToolsExtensions.REDUX_DEVTOOLS
];
for (const extension of extensionsToInstall) {
// WARNING: depending on a lot of things including the version of Electron `installExtension` might
// return a promise that never resolves, especially if the extension is already installed.
installExtension(extension).then(
extensionName => log(`Installed dev extension: ${extensionName}`),
errorMessage => log.error(`Error installing dev extension: ${errorMessage}`)
);
}
});
}
ipcMain.on('clearCache', () => {
desktopLink.clearCache();
});
ipcMain.on('installDriver', () => {
desktopLink.installDriver(() => {
dialog.showMessageBox(_windows.main, {
type: 'info',
message: `${formatMessage({
id: 'index.systemRestartRequired',
default: 'Installation is complete, please restart the system.',
description: 'prompt for restart system'
})}`
});
});
});
// create a loading windows let user know the app is starting
_windows.loading = createLoadingWindow();
_windows.loading.once('show', () => {
// TODO: This code should be deleted afterwards
// Due to the changes in cache logic updates, before adding the online
// library version, clear the cache directly to prevent the old cache
// content from interfering with the operation of the new version.
desktopLink.clearCache(false);
desktopLink.start();
_windows.main = createMainWindow();
_windows.main.on('closed', () => {
delete _windows.main;
});
// In order to fix the bug caused by using alert on windows
// https://github.com/electron/electron/issues/20400
if (process.platform === 'win32') {
let needsFocusFix = false;
let triggeringProgrammaticBlur = false;
_windows.main.on('blur', () => {
if (!triggeringProgrammaticBlur) {
needsFocusFix = true;
}
});
_windows.main.on('focus', () => {
if (needsFocusFix) {
needsFocusFix = false;
triggeringProgrammaticBlur = true;
setTimeout(() => {
if (_windows.main) {
_windows.main.blur();
_windows.main.focus();
setTimeout(() => {
triggeringProgrammaticBlur = false;
}, 100);
}
}, 100);
}
});
}
_windows.about = createAboutWindow();
_windows.about.on('close', event => {
event.preventDefault();
_windows.about.hide();
});
_windows.license = createLicenseWindow();
_windows.license.on('close', event => {
event.preventDefault();
_windows.license.hide();
});
_windows.privacy = createPrivacyWindow();
_windows.privacy.on('close', event => {
event.preventDefault();
_windows.privacy.hide();
});
// after finsh load progress show main window and close loading window
_windows.main.show();
_windows.loading.close();
delete _windows.loading;
});
});
ipcMain.on('open-about-window', () => {
_windows.about.show();
});
ipcMain.on('open-license-window', () => {
_windows.license.show();
});
ipcMain.on('open-privacy-policy-window', () => {
_windows.privacy.show();
});
ipcMain.on('set-locale', (event, arg) => {
formatMessage.setup({locale: arg});
});
// start loading initial project data before the GUI needs it so the load seems faster
const initialProjectDataPromise = (async () => {
if (argv._.length === 0) {
// no command line argument means no initial project data
return;
}
if (argv._.length > 1) {
log.warn(`Expected 1 command line argument but received ${argv._.length}.`);
}
const projectPath = argv._[argv._.length - 1];
try {
const projectData = await promisify(fs.readFile)(projectPath, null);
return projectData;
} catch (e) {
dialog.showMessageBox(_windows.main, {
type: 'error',
title: 'Failed to load project',
message: `${formatMessage({
id: 'index.failedLoadProject',
default: 'Could not load project from file:',
description: 'prompt for failed to load project'
})}\n${projectPath}`,
detail: e.message
});
}
// load failed: initial project data undefined
})(); // IIFE
ipcMain.handle('get-initial-project-data', () => initialProjectDataPromise);