| /******************************************************************************* |
| * Copyright (c) 2007 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - Initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.ptp.remote.remotetools.core; |
| |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.ListenerList; |
| import org.eclipse.core.runtime.NullProgressMonitor; |
| import org.eclipse.ptp.remote.core.IRemoteConnection; |
| import org.eclipse.ptp.remote.core.IRemoteConnectionChangeEvent; |
| import org.eclipse.ptp.remote.core.IRemoteConnectionChangeListener; |
| import org.eclipse.ptp.remote.core.exception.AddressInUseException; |
| import org.eclipse.ptp.remote.core.exception.RemoteConnectionException; |
| import org.eclipse.ptp.remote.core.exception.UnableToForwardPortException; |
| import org.eclipse.ptp.remote.remotetools.core.environment.PTPTargetControl; |
| import org.eclipse.ptp.remote.remotetools.core.messages.Messages; |
| import org.eclipse.ptp.remotetools.core.IRemoteExecutionManager; |
| import org.eclipse.ptp.remotetools.environment.control.ITargetStatus; |
| import org.eclipse.ptp.remotetools.environment.core.ITargetElement; |
| import org.eclipse.ptp.remotetools.exception.CancelException; |
| import org.eclipse.ptp.remotetools.exception.LocalPortBoundException; |
| import org.eclipse.ptp.remotetools.exception.PortForwardingException; |
| import org.eclipse.ptp.remotetools.exception.RemoteExecutionException; |
| |
| public class RemoteToolsConnection implements IRemoteConnection { |
| private String fConnName; |
| private String fAddress; |
| private String fUserName; |
| private final ITargetElement fTargetElement; |
| private final PTPTargetControl fTargetControl; |
| |
| private Map<String, String> fEnv = null; |
| private Map<String, String> fProperties = null; |
| private final ListenerList fListeners = new ListenerList(); |
| |
| public RemoteToolsConnection(String name, String address, String userName, ITargetElement element) throws CoreException { |
| fTargetElement = element; |
| fTargetControl = (PTPTargetControl)element.getControl(); |
| fConnName = name; |
| fAddress = address; |
| fUserName = userName; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#addConnectionChangeListener(org.eclipse.ptp.remote.core.IRemoteConnectionChangeListener) |
| */ |
| public void addConnectionChangeListener(IRemoteConnectionChangeListener listener) { |
| fListeners.add(listener); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#close() |
| */ |
| public synchronized void close() { |
| IProgressMonitor monitor = new NullProgressMonitor(); |
| |
| monitor.beginTask(Messages.RemoteToolsConnection_close, 1); |
| |
| if (isOpen()) { |
| try { |
| fTargetControl.kill(monitor); |
| } catch (CoreException e) { |
| } |
| |
| monitor.done(); |
| } |
| } |
| |
| /** |
| * Create a new execution manager. Required because script execution |
| * closes channel after execution. |
| * |
| * @return execution manager |
| * @throws org.eclipse.ptp.remotetools.exception.RemoteConnectionException |
| */ |
| public IRemoteExecutionManager createExecutionManager() throws org.eclipse.ptp.remotetools.exception.RemoteConnectionException { |
| return fTargetControl.createExecutionManager(); |
| } |
| |
| /** |
| * Notify all fListeners when this connection's status changes. |
| * |
| * @param event |
| */ |
| public void fireConnectionChangeEvent(final IRemoteConnection connection, final int type) { |
| IRemoteConnectionChangeEvent event = new IRemoteConnectionChangeEvent() { |
| public IRemoteConnection getConnection() { |
| return connection; |
| } |
| public int getType() { |
| return type; |
| } |
| }; |
| for (Object listener : fListeners.getListeners()) { |
| ((IRemoteConnectionChangeListener)listener).connectionChanged(event); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#forwardLocalPort(int, java.lang.String, int) |
| */ |
| public void forwardLocalPort(int localPort, String fwdAddress, int fwdPort) |
| throws RemoteConnectionException { |
| if (!isOpen()) { |
| throw new RemoteConnectionException(Messages.RemoteToolsConnection_connectionNotOpen); |
| } |
| try { |
| fTargetControl.getExecutionManager().createTunnel(localPort, fwdAddress, fwdPort); |
| } catch (LocalPortBoundException e) { |
| throw new AddressInUseException(e.getMessage()); |
| } catch (org.eclipse.ptp.remotetools.exception.RemoteConnectionException e) { |
| throw new RemoteConnectionException(e.getMessage()); |
| } catch (CancelException e) { |
| throw new RemoteConnectionException(e.getMessage()); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#forwardLocalPort(java.lang.String, int, org.eclipse.core.runtime.IProgressMonitor) |
| */ |
| public int forwardLocalPort(String fwdAddress, int fwdPort, |
| IProgressMonitor monitor) throws RemoteConnectionException { |
| if (!isOpen()) { |
| throw new RemoteConnectionException(Messages.RemoteToolsConnection_connectionNotOpen); |
| } |
| if (monitor == null) { |
| monitor = new NullProgressMonitor(); |
| } |
| monitor.beginTask(Messages.RemoteToolsConnection_forwarding, 10); |
| /* |
| * Start with a different port number, in case we're doing this all on localhost. |
| */ |
| int localPort = fwdPort + 1; |
| |
| /* |
| * Try to find a free port on the remote machine. This take a while, so |
| * allow it to be canceled. If we've tried all ports (which could take a |
| * very long while) then bail out. |
| */ |
| try { |
| while (!monitor.isCanceled()) { |
| try { |
| forwardLocalPort(localPort, fwdAddress, fwdPort); |
| } catch (AddressInUseException e) { |
| if (++localPort == fwdPort) { |
| throw new UnableToForwardPortException(Messages.RemoteToolsConnection_remotePort); |
| } |
| monitor.worked(1); |
| } |
| return localPort; |
| } |
| } finally { |
| monitor.done(); |
| } |
| return -1; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#forwardRemotePort(int, java.lang.String, int) |
| */ |
| public void forwardRemotePort(int remotePort, String fwdAddress, int fwdPort) |
| throws RemoteConnectionException { |
| if (!isOpen()) { |
| throw new RemoteConnectionException(Messages.RemoteToolsConnection_connectionNotOpen); |
| } |
| try { |
| fTargetControl.getExecutionManager().getPortForwardingTools().forwardRemotePort(remotePort, fwdAddress, fwdPort); |
| } catch (org.eclipse.ptp.remotetools.exception.RemoteConnectionException e) { |
| throw new RemoteConnectionException(e.getMessage()); |
| } catch (CancelException e) { |
| throw new RemoteConnectionException(e.getMessage()); |
| } catch (PortForwardingException e) { |
| throw new AddressInUseException(e.getMessage()); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#forwardRemotePort(java.lang.String, int, org.eclipse.core.runtime.IProgressMonitor) |
| */ |
| public int forwardRemotePort(String fwdAddress, int fwdPort, |
| IProgressMonitor monitor) throws RemoteConnectionException { |
| if (!isOpen()) { |
| throw new RemoteConnectionException(Messages.RemoteToolsConnection_connectionNotOpen); |
| } |
| if (monitor == null) { |
| monitor = new NullProgressMonitor(); |
| } |
| monitor.beginTask(Messages.RemoteToolsConnection_forwarding, 10); |
| /* |
| * Start with a different port number, in case we're doing this all on localhost. |
| */ |
| int remotePort = fwdPort + 1; |
| /* |
| * Try to find a free port on the remote machine. This take a while, so |
| * allow it to be canceled. If we've tried all ports (which could take a |
| * very long while) then bail out. |
| */ |
| try { |
| while (!monitor.isCanceled()) { |
| try { |
| forwardRemotePort(remotePort, fwdAddress, fwdPort); |
| } catch (AddressInUseException e) { |
| if (++remotePort == fwdPort) { |
| throw new UnableToForwardPortException(Messages.RemoteToolsConnection_remotePort); |
| } |
| monitor.worked(1); |
| } |
| monitor.done(); |
| return remotePort; |
| } |
| } finally { |
| monitor.done(); |
| } |
| return -1; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getAddress() |
| */ |
| public String getAddress() { |
| return fAddress; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getAttributes() |
| */ |
| public Map<String, String> getAttributes() { |
| return fTargetControl.getAttributes(); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getEnv() |
| */ |
| public Map<String, String> getEnv() { |
| if (fEnv == null) { |
| fEnv = new HashMap<String, String>(); |
| |
| IRemoteExecutionManager exeMgr = null; |
| try { |
| exeMgr = createExecutionManager(); |
| } catch (org.eclipse.ptp.remotetools.exception.RemoteConnectionException e) { |
| // Ignore |
| } |
| if (exeMgr != null) { |
| try { |
| String env = exeMgr.getExecutionTools().executeWithOutput("printenv").trim(); //$NON-NLS-1$ |
| String[] vars = env.split("\n"); //$NON-NLS-1$ |
| for (String var : vars) { |
| String[] kv = var.split("="); //$NON-NLS-1$ |
| if (kv.length == 2) { |
| fEnv.put(kv[0], kv[1]); |
| } |
| } |
| } catch (RemoteExecutionException e) { |
| } catch (org.eclipse.ptp.remotetools.exception.RemoteConnectionException e) { |
| } catch (CancelException e) { |
| } |
| } |
| } |
| return fEnv; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getEnv(java.lang.String) |
| */ |
| public String getEnv(String name) { |
| getEnv(); |
| return fEnv.get(name); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getName() |
| */ |
| public String getName() { |
| return fConnName; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getProperty(java.lang.String) |
| */ |
| public String getProperty(String key) { |
| loadProperties(); |
| return fProperties.get(key); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#getUsername() |
| */ |
| public String getUsername() { |
| return fUserName; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#isOpen() |
| */ |
| public synchronized boolean isOpen() { |
| return fTargetControl.query() == ITargetStatus.RESUMED; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#open() |
| */ |
| public void open(IProgressMonitor monitor) throws RemoteConnectionException { |
| if (monitor == null) { |
| monitor = new NullProgressMonitor(); |
| } |
| if (fTargetControl.query() == ITargetStatus.STOPPED) { |
| monitor.beginTask(Messages.RemoteToolsConnection_open, 2); |
| try { |
| fTargetControl.create(monitor); |
| } catch (CoreException e) { |
| throw new RemoteConnectionException(e); |
| } |
| } |
| monitor.done(); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#removeConnectionChangeListener(org.eclipse.ptp.remote.core.IRemoteConnectionChangeListener) |
| */ |
| public void removeConnectionChangeListener(IRemoteConnectionChangeListener listener) { |
| fListeners.remove(listener); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#setAddress(java.lang.String) |
| */ |
| public void setAddress(String address) { |
| fAddress = address; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#setName(java.lang.String) |
| */ |
| public void setName(String name) { |
| fTargetElement.setName(name); |
| fireConnectionChangeEvent(this, IRemoteConnectionChangeEvent.CONNECTION_RENAMED); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#setUsername(java.lang.String) |
| */ |
| public void setUsername(String userName) { |
| fUserName = userName; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ptp.remote.core.IRemoteConnection#supportsTCPPortForwarding() |
| */ |
| public boolean supportsTCPPortForwarding() { |
| return true; |
| } |
| |
| private void loadProperties() { |
| if (fProperties == null) { |
| fProperties = new HashMap<String, String>(); |
| fProperties.put(FILE_SERPARATOR_PROPERTY, "/"); //$NON-NLS-1$ |
| fProperties.put(PATH_SERPARATOR_PROPERTY, ":"); //$NON-NLS-1$ |
| fProperties.put(LINE_SERPARATOR_PROPERTY, "\n"); //$NON-NLS-1$ |
| |
| try { |
| IRemoteExecutionManager exeMgr = createExecutionManager(); |
| if (exeMgr != null) { |
| String osVersion; |
| String osArch = exeMgr.getExecutionTools().executeWithOutput("uname -m").trim(); //$NON-NLS-1$ |
| String osName = exeMgr.getExecutionTools().executeWithOutput("uname").trim(); //$NON-NLS-1$ |
| if (osName.equalsIgnoreCase("Darwin")) { //$NON-NLS-1$ |
| osName = exeMgr.getExecutionTools().executeWithOutput("sw_vers -productName").trim(); //$NON-NLS-1$ |
| osVersion = exeMgr.getExecutionTools().executeWithOutput("sw_vers -productVersion").trim(); //$NON-NLS-1$ |
| if (osArch.equalsIgnoreCase("i386")) { //$NON-NLS-1$ |
| String opt = exeMgr.getExecutionTools().executeWithOutput("sysctl -n hw.optional.x86_64").trim(); //$NON-NLS-1$ |
| if (opt.equals("1")) { //$NON-NLS-1$ |
| osArch = "x86_64"; //$NON-NLS-1$ |
| } |
| } |
| } else { |
| osVersion = exeMgr.getExecutionTools().executeWithOutput("uname -r").trim(); //$NON-NLS-1$ |
| } |
| fProperties.put(OS_NAME_PROPERTY, osName); |
| fProperties.put(OS_VERSION_PROPERTY, osVersion); |
| fProperties.put(OS_ARCH_PROPERTY, osArch); |
| } |
| } catch (RemoteExecutionException e) { |
| } catch (org.eclipse.ptp.remotetools.exception.RemoteConnectionException e) { |
| } catch (CancelException e) { |
| } |
| } |
| } |
| } |
