open-journal-workspace.ts

// Copyright (C) 2021  Patrick Maué
// 
// This file is part of vscode-journal.
// 
// vscode-journal is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// vscode-journal 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 General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with vscode-journal.  If not, see <http://www.gnu.org/licenses/>.
// 
'use strict';

import * as vscode from 'vscode';
import { JournalController } from '../model';
import { isRemoteSession, toLocalFileUri } from '../journal/paths';


export class OpenJournalWorkspaceCommand implements vscode.Command, vscode.Disposable {
    title: string = 'Open the journal workspace';
    command: string = 'journal.open';


    protected constructor(public ctrl: JournalController) { }

    public async dispose(): Promise<void> {
        // do nothing
    }

    public static create(ctrl: JournalController): vscode.Disposable {
        const cmd = new this(ctrl);
        vscode.commands.registerCommand(cmd.command, () => cmd.openWorkspace());
        return cmd;

    }

    /**
     * Called by command 'Journal:open'. Opens a new windows with the Journal base directory as root. 
     *
     * @returns {Q.Promise<void>}
     * @memberof JournalCommands
     */
    public async openWorkspace(): Promise<void> {
        this.ctrl.logger.trace("Executing command: ", this.command);

        let path = vscode.Uri.file(this.ctrl.config.getBasePath());

        try {
            if (isRemoteSession()) {
                const openLocal = "Open local journal";
                const forceRemote = "Open journal in remote session";
                const choice = await vscode.window.showWarningMessage(
                    "You are in a remote session. Choose where to open the journal.",
                    { modal: true },
                    openLocal,
                    forceRemote
                );

                if (choice === openLocal) {
                    await this.openInLocalWindow();
                    return;
                }

                if (choice !== forceRemote) {
                    return;
                }
            }

            await vscode.commands.executeCommand('vscode.openFolder', path, true);
        } catch (error) {
            this.ctrl.logger.error("Failed to execute command: ", this.command, "Reason: ", error);
            this.ctrl.ui.showError("Failed to open the journal workspace.");
        }
    }

    private async openInLocalWindow(): Promise<void> {
        const localBase = this.ctrl.config.getBasePathForLocalOpen();
        const localOpenUri = toLocalFileUri(localBase);

        this.ctrl.logger.debug('Opening local journal path via external URI:', localOpenUri.toString());
        const success = await vscode.env.openExternal(localOpenUri);
        if (!success) {
            this.ctrl.logger.error('openExternal returned false for local journal URI:', localOpenUri.toString());
            throw new Error(`Failed to open local journal path: ${localBase}`);
        }
    }


}