remote/org.eclipse.remote.console/src/org/eclipse/remote/internal/console/TerminalConsoleFactory.java

/*******************************************************************************
 * Copyright (c) 2015 QNX Software Systems and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 * QNX Software Systems - Initial API and implementation
 *******************************************************************************/
package org.eclipse.remote.internal.console;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.window.Window;
import org.eclipse.remote.core.IRemoteCommandShellService;
import org.eclipse.remote.core.IRemoteConnection;
import org.eclipse.remote.core.exception.RemoteConnectionException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.console.ConsolePlugin;
import org.eclipse.ui.console.IConsole;
import org.eclipse.ui.console.IConsoleFactory;
import org.eclipse.ui.console.IConsoleManager;

public class TerminalConsoleFactory implements IConsoleFactory {

	@Override
	public void openConsole() {
		final TerminalConsoleSettingsDialog settingsDialog = new TerminalConsoleSettingsDialog(
				PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
		if (settingsDialog.open() == Window.OK) {
			openConsole(settingsDialog.getRemoteConnection(), settingsDialog.getEncoding());
		}
	}

	public static void openConsole(final IRemoteConnection connection, final String encoding) {
		Job j = new Job(ConsoleMessages.OPENNING_TERMINAL) {
			@Override
			public IStatus run(IProgressMonitor monitor) {
				return openConsoleImplementation(connection, encoding, monitor);
			}
		};
		j.schedule();
	}

	private static IStatus openConsoleImplementation(final IRemoteConnection connection, final String encoding,
			IProgressMonitor monitor) {
		IRemoteCommandShellService commandShellService = connection.getService(IRemoteCommandShellService.class);
		if (commandShellService == null) {
			return Status.CANCEL_STATUS;
		}
		try {
			createConsole(connection, encoding, commandShellService, monitor);
			return Status.OK_STATUS;
		} catch (RemoteConnectionException rce) {
			return rce.getStatus();
		}

	}

	private static IConsole createConsole(final IRemoteConnection connection, final String encoding,
			IRemoteCommandShellService service, IProgressMonitor monitor) throws RemoteConnectionException {
		if (!connection.isOpen()) {
			connection.open(monitor);
		}

		// TODO, how to handle command shells that are singletons, like serial ports

		IConsoleManager consoleManager = ConsolePlugin.getDefault().getConsoleManager();
		// Find the next index;
		int index = findNextIndex(consoleManager, connection);

		TerminalConsole terminalConsole = new TerminalConsole(connection, index, encoding);
		consoleManager.addConsoles(new IConsole[] { terminalConsole });
		consoleManager.showConsoleView(terminalConsole);
		return terminalConsole;
	}

	private static int findNextIndex(IConsoleManager consoleManager, IRemoteConnection connection) {
		IConsole[] consoles = consoleManager.getConsoles();
		boolean[] indices = new boolean[consoles.length];
		for (IConsole console : consoles) {
			if (console instanceof TerminalConsole) {
				TerminalConsole terminalConsole = (TerminalConsole) console;
				if (terminalConsole.getConnection().equals(connection)) {
					indices[terminalConsole.getIndex()] = true;
				}
			}
		}
		int index = 0;
		while (index < indices.length && indices[index]) {
			index++;
		}
		return index;
	}

	public static List<IConsole> findConsole(IRemoteConnection connection) {
		ArrayList<IConsole> ret = new ArrayList<>();
		IConsoleManager consoleManager = ConsolePlugin.getDefault().getConsoleManager();
		IConsole[] consoles = consoleManager.getConsoles();
		for (IConsole console : consoles) {
			if (console instanceof TerminalConsole) {
				TerminalConsole terminalConsole = (TerminalConsole) console;
				if (terminalConsole.getConnection().equals(connection)) {
					ret.add(terminalConsole);
				}
			}
		}
		return ret;
	}

}