feat: Open in external browser

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

13 files changed, 140 insertions, 30 deletions

diff --git a/packages/main/src/index.ts b/packages/main/src/index.ts
index 40b15f0..869c555 100644
--- a/packages/main/src/index.ts
+++ b/packages/main/src/index.ts
@@ -26,8 +26,9 @@ import { ensureDirSync } from 'fs-extra';
 import osName from 'os-name';
 
 import { enableStacktraceSourceMaps } from './infrastructure/electron/impl/devTools';
+import electronShell from './infrastructure/electron/impl/electronShell';
 import initReactions from './initReactions';
-import { createMainStore } from './stores/MainStore';
+import MainStore from './stores/MainStore';
 import { getLogger } from './utils/log';
 
 const isDevelopment = import.meta.env.MODE === 'development';
@@ -77,7 +78,7 @@ app.setAboutPanelOptions({
   version: '',
 });
 
-const store = createMainStore();
+const store = MainStore.create({}, electronShell);
 
 app.on('second-instance', () => {
   store.mainWindow?.bringToForeground();
diff --git a/packages/main/src/infrastructure/electron/impl/electronShell.ts b/packages/main/src/infrastructure/electron/impl/electronShell.ts
new file mode 100644
index 0000000..0e8c0c1
--- /dev/null
+++ b/packages/main/src/infrastructure/electron/impl/electronShell.ts
@@ -0,0 +1,36 @@
+/*
+ * 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 { shell } from 'electron';
+import { getLogger } from 'loglevel';
+
+import type MainEnv from '../../../stores/MainEnv';
+
+const log = getLogger('ElectronShell');
+
+const electronShell: MainEnv = {
+  openURLInExternalBrowser(url: string): void {
+    shell.openExternal(url).catch((error) => {
+      log.error('Failed to open', url, 'in external program', error);
+    });
+  },
+};
+
+export default electronShell;
diff --git a/packages/renderer/src/env/RendererEnv.ts b/packages/main/src/stores/MainEnv.ts
index ba4c43e..94c34f3 100644
--- a/packages/renderer/src/env/RendererEnv.ts
+++ b/packages/main/src/stores/MainEnv.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
  *
  * This file is part of Sophie.
  *
@@ -18,8 +18,12 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import type { Action } from '@sophie/shared';
+import { getEnv as getAnyEnv, IAnyStateTreeNode } from 'mobx-state-tree';
 
-export default interface RendererEnv {
-  dispatchMainAction(action: Action): void;
+export function getEnv(model: IAnyStateTreeNode): MainEnv {
+  return getAnyEnv<MainEnv>(model);
+}
+
+export default interface MainEnv {
+  openURLInExternalBrowser(url: string): void;
 }
diff --git a/packages/main/src/stores/MainStore.ts b/packages/main/src/stores/MainStore.ts
index dedc740..ed0f391 100644
--- a/packages/main/src/stores/MainStore.ts
+++ b/packages/main/src/stores/MainStore.ts
@@ -124,7 +124,3 @@ const MainStore = types
 interface MainStore extends Instance<typeof MainStore> {}
 
 export default MainStore;
-
-export function createMainStore(): MainStore {
-  return MainStore.create();
-}
diff --git a/packages/main/src/stores/Service.ts b/packages/main/src/stores/Service.ts
index 9b2bf1e..26e3517 100644
--- a/packages/main/src/stores/Service.ts
+++ b/packages/main/src/stores/Service.ts
@@ -30,6 +30,7 @@ import { Instance, getSnapshot, cast } from 'mobx-state-tree';
 import type { ServiceView } from '../infrastructure/electron/types';
 import { getLogger } from '../utils/log';
 
+import { getEnv } from './MainEnv';
 import ServiceSettings from './ServiceSettings';
 import type ServiceConfig from './config/ServiceConfig';
 
@@ -88,6 +89,22 @@ const Service = defineServiceModel(ServiceSettings)
         self.indirectMessageCount = indirect;
       }
     },
+    goBack(): void {
+      self.serviceView?.goBack();
+    },
+    goForward(): void {
+      self.serviceView?.goForward();
+    },
+    stop(): void {
+      self.serviceView?.stop();
+    },
+    openCurrentURLInExternalBrowser(): void {
+      if (self.currentUrl === undefined) {
+        log.error('Cannot open empty URL in external browser');
+        return;
+      }
+      getEnv(self).openURLInExternalBrowser(self.currentUrl);
+    },
   }))
   .actions((self) => {
     function setState(state: ServiceStateSnapshotIn): void {
@@ -134,12 +151,6 @@ const Service = defineServiceModel(ServiceSettings)
           });
         }
       },
-      goBack(): void {
-        self.serviceView?.goBack();
-      },
-      goForward(): void {
-        self.serviceView?.goForward();
-      },
       reload(ignoreCache = false): void {
         if (self.serviceView === undefined) {
           setState({ type: 'initializing' });
@@ -147,9 +158,6 @@ const Service = defineServiceModel(ServiceSettings)
           self.serviceView?.reload(ignoreCache);
         }
       },
-      stop(): void {
-        self.serviceView?.stop();
-      },
       go(url: string): void {
         if (self.serviceView === undefined) {
           self.currentUrl = url;
@@ -207,6 +215,9 @@ const Service = defineServiceModel(ServiceSettings)
         case 'temporarily-trust-current-certificate':
           self.temporarilyTrustCurrentCertificate(action.fingerprint);
           break;
+        case 'open-current-url-in-external-browser':
+          self.openCurrentURLInExternalBrowser();
+          break;
         default:
           log.error('Unknown action to dispatch', action);
           break;
diff --git a/packages/renderer/src/components/locationBar/ExtraButtons.tsx b/packages/renderer/src/components/locationBar/ExtraButtons.tsx
new file mode 100644
index 0000000..4eaee29
--- /dev/null
+++ b/packages/renderer/src/components/locationBar/ExtraButtons.tsx
@@ -0,0 +1,52 @@
+/*
+ * 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 IconOpenInBrowser from '@mui/icons-material/OpenInBrowser';
+import Box from '@mui/material/Box';
+import IconButton from '@mui/material/IconButton';
+import { observer } from 'mobx-react-lite';
+import React from 'react';
+
+import type Service from '../../stores/Service';
+
+function ExtraButtons({
+  service,
+}: {
+  service: Service | undefined;
+}): JSX.Element {
+  return (
+    <Box
+      sx={{
+        display: 'flex',
+        flexDirection: 'row',
+      }}
+    >
+      <IconButton
+        aria-label="Open in browser"
+        disabled={service?.currentUrl === undefined}
+        onClick={() => service?.openCurrentURLInExternalBrowser()}
+      >
+        <IconOpenInBrowser />
+      </IconButton>
+    </Box>
+  );
+}
+
+export default observer(ExtraButtons);
diff --git a/packages/renderer/src/components/locationBar/LocationBar.tsx b/packages/renderer/src/components/locationBar/LocationBar.tsx
index 0debaab..fc9c147 100644
--- a/packages/renderer/src/components/locationBar/LocationBar.tsx
+++ b/packages/renderer/src/components/locationBar/LocationBar.tsx
@@ -24,6 +24,7 @@ import React from 'react';
 
 import { useStore } from '../StoreProvider';
 
+import ExtraButtons from './ExtraButtons';
 import LocationTextField from './LocationTextField';
 import NavigationButtons from './NavigationButtons';
 
@@ -49,6 +50,7 @@ function LocationBar(): JSX.Element {
     <LocationBarRoot id={LOCATION_BAR_ID} hidden={!showLocationBar}>
       <NavigationButtons service={selectedService} />
       <LocationTextField service={selectedService} />
+      <ExtraButtons service={selectedService} />
     </LocationBarRoot>
   );
 }
diff --git a/packages/renderer/src/components/locationBar/NavigationButtons.tsx b/packages/renderer/src/components/locationBar/NavigationButtons.tsx
index 5c5c959..9995a21 100644
--- a/packages/renderer/src/components/locationBar/NavigationButtons.tsx
+++ b/packages/renderer/src/components/locationBar/NavigationButtons.tsx
@@ -29,7 +29,7 @@ import IconButton from '@mui/material/IconButton';
 import { observer } from 'mobx-react-lite';
 import React from 'react';
 
-import Service from '../../stores/Service';
+import type Service from '../../stores/Service';
 
 function NavigationButtons({
   service,
diff --git a/packages/renderer/src/stores/GlobalSettings.ts b/packages/renderer/src/stores/GlobalSettings.ts
index 79815ba..52971d4 100644
--- a/packages/renderer/src/stores/GlobalSettings.ts
+++ b/packages/renderer/src/stores/GlobalSettings.ts
@@ -21,8 +21,7 @@
 import { defineGlobalSettingsModel, ThemeSource } from '@sophie/shared';
 import { Instance } from 'mobx-state-tree';
 
-import getEnv from '../env/getEnv';
-
+import { getEnv } from './RendererEnv';
 import Service from './Service';
 
 const GlobalSettings = defineGlobalSettingsModel(Service).actions((self) => ({
diff --git a/packages/renderer/src/env/getEnv.ts b/packages/renderer/src/stores/RendererEnv.ts
index 4f7357a..496ede6 100644
--- a/packages/renderer/src/env/getEnv.ts
+++ b/packages/renderer/src/stores/RendererEnv.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
+ * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
  *
  * This file is part of Sophie.
  *
@@ -18,10 +18,9 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
+import type { Action } from '@sophie/shared';
 import { getEnv as getAnyEnv, IAnyStateTreeNode } from 'mobx-state-tree';
 
-import type RendererEnv from './RendererEnv';
-
 /**
  * Gets a well-typed environment from `model`.
  *
@@ -29,6 +28,10 @@ import type RendererEnv from './RendererEnv';
  *
  * @param model The state tree node.
  */
-export default function getEnv(model: IAnyStateTreeNode): RendererEnv {
+export function getEnv(model: IAnyStateTreeNode): RendererEnv {
   return getAnyEnv<RendererEnv>(model);
 }
+
+export default interface RendererEnv {
+  dispatchMainAction(action: Action): void;
+}
diff --git a/packages/renderer/src/stores/RendererStore.ts b/packages/renderer/src/stores/RendererStore.ts
index 8f424f6..f48d484 100644
--- a/packages/renderer/src/stores/RendererStore.ts
+++ b/packages/renderer/src/stores/RendererStore.ts
@@ -21,11 +21,10 @@
 import { BrowserViewBounds, SophieRenderer } from '@sophie/shared';
 import { applySnapshot, applyPatch, Instance, types } from 'mobx-state-tree';
 
-import RendererEnv from '../env/RendererEnv';
-import getEnv from '../env/getEnv';
 import { getLogger } from '../utils/log';
 
 import GlobalSettings from './GlobalSettings';
+import RendererEnv, { getEnv } from './RendererEnv';
 import Service from './Service';
 import SharedStore from './SharedStore';
 
diff --git a/packages/renderer/src/stores/Service.ts b/packages/renderer/src/stores/Service.ts
index 695cff4..c50e5bd 100644
--- a/packages/renderer/src/stores/Service.ts
+++ b/packages/renderer/src/stores/Service.ts
@@ -21,8 +21,7 @@
 import { defineServiceModel, ServiceAction } from '@sophie/shared';
 import { Instance } from 'mobx-state-tree';
 
-import getEnv from '../env/getEnv';
-
+import { getEnv } from './RendererEnv';
 import ServiceSettings from './ServiceSettings';
 
 const Service = defineServiceModel(ServiceSettings).actions((self) => {
@@ -76,6 +75,11 @@ const Service = defineServiceModel(ServiceSettings).actions((self) => {
         fingerprint: self.state.certificate.fingerprint,
       });
     },
+    openCurrentURLInExternalBrowser(): void {
+      dispatch({
+        action: 'open-current-url-in-external-browser',
+      });
+    },
   };
 });
 
diff --git a/packages/shared/src/schemas/ServiceAction.ts b/packages/shared/src/schemas/ServiceAction.ts
index 8961bfe..da0b96b 100644
--- a/packages/shared/src/schemas/ServiceAction.ts
+++ b/packages/shared/src/schemas/ServiceAction.ts
@@ -46,6 +46,9 @@ export const ServiceAction = /* @__PURE__ */ (() =>
       action: z.literal('temporarily-trust-current-certificate'),
       fingerprint: z.string(),
     }),
+    z.object({
+      action: z.literal('open-current-url-in-external-browser'),
+    }),
   ]))();
 
 /*