aboutsummaryrefslogtreecommitdiffstats
path: root/packages/main/src/infrastructure/electron/impl/lockWebContentsToFile.ts
blob: 6b458e099af58cc752273732770d219a28d5a5aa (plain) (blame)
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
/*
 * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
 *
 * This file is part of Sophie.
 *
 * Sophie is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { WebContents } from 'electron';

import { getLogger } from '../../../utils/log';
import type Resources from '../../resources/Resources';

const log = getLogger('lockWebContentsToFile');

/**
 * Loads the specified file in the webContents and prevent navigating away.
 *
 * Both navigating away to a different URL and opening a new window will be disallowed.
 *
 * @param resources The resource handle associated with the paths and URL of the application.
 * @param filePath The path to the file in the render package to load.
 * @param webContents The webContents to lock.
 */
export default function lockWebContentsToFile(
  resources: Resources,
  filePath: string,
  webContents: WebContents,
): Promise<void> {
  const pageURL = resources.getRendererURL(filePath);

  webContents.setWindowOpenHandler(() => ({ action: 'deny' }));

  webContents.on('will-navigate', (event, url) => {
    if (url !== pageURL) {
      log.error(
        'Prevented webContents locked to',
        pageURL,
        'from navigating to',
        url,
      );
      event.preventDefault();
    }
  });

  return webContents.loadURL(pageURL);
}