SftpTransport.java

/*
 * $Id$
 *
 * Authors:
 *      Jeff Buchbinder <jeff@freemedsoftware.org>
 *
 * REMITT Electronic Medical Information Translation and Transmission
 * Copyright (C) 1999-2014 FreeMED Software Foundation
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

package org.remitt.plugin.transport;

import java.io.ByteArrayInputStream;
import java.util.HashMap;

import org.apache.log4j.Logger;
import org.remitt.prototype.PluginInterface;
import org.remitt.server.Configuration;

import com.sshtools.j2ssh.SftpClient;
import com.sshtools.j2ssh.SshClient;
import com.sshtools.j2ssh.authentication.AuthenticationProtocolState;
import com.sshtools.j2ssh.authentication.PasswordAuthenticationClient;
import com.sshtools.j2ssh.transport.IgnoreHostKeyVerification;

public class SftpTransport implements PluginInterface {

	static final Logger log = Logger.getLogger(SftpTransport.class);

	protected String defaultUsername = "";

	@Override
	public String getInputFormat() {
		return "text";
	}

	@Override
	public HashMap<String, String> getOptions() {
		return null;
	}

	@Override
	public String getOutputFormat() {
		return null;
	}

	@Override
	public String[] getPluginConfigurationOptions() {
		return new String[] { "sftpUsername", "sftpPassword", "sftpHost",
				"sftpPort", "sftpPath" };
	}

	@Override
	public String getPluginName() {
		return "SftpTransport";
	}

	@Override
	public Double getPluginVersion() {
		return 0.1;
	}

	@Override
	public byte[] render(Integer jobId, byte[] input, String option)
			throws Exception {
		log.info("Entered Transport for job #" + jobId.toString());

		String userName = null;
		if (jobId == 0) {
			userName = defaultUsername;
		} else {
			userName = Configuration.getControlThread()
					.getPayloadFromProcessor(jobId).getUserName();
		}

		String tempPathName = getOutputFileName(input);

		SshClient ssh = new SshClient();

		String host = getSftpHost(userName);
		Integer port = getSftpPort(userName);
		String sftpUser = getSftpUser(userName);
		String sftpPassword = getSftpPassword(userName);
		String sftpPath = getSftpPath(userName);

		// Perform initial connection
		ssh.connect(host, port, new IgnoreHostKeyVerification());

		// Authenticate
		PasswordAuthenticationClient passwordAuthenticationClient = new PasswordAuthenticationClient();
		passwordAuthenticationClient.setUsername(sftpUser);
		passwordAuthenticationClient.setPassword(sftpPassword);
		int result = ssh.authenticate(passwordAuthenticationClient);
		if (result != AuthenticationProtocolState.COMPLETE) {
			throw new Exception("Login to " + host + ":" + port + " "
					+ sftpUser + "/" + sftpPassword + " failed");
		}
		// Open the SFTP channel
		SftpClient client = ssh.openSftpClient();

		if (sftpPath != null && sftpPath != "") {
			client.cd(sftpPath);
		}

		// Convert string to input stream for transfer
		ByteArrayInputStream bs = new ByteArrayInputStream(prepareInput(input));

		// Send the file
		client.put(bs, tempPathName);

		// Disconnect
		client.quit();
		ssh.disconnect();

		log.info("Leaving Transport for job #" + jobId.toString());

		return new String("").getBytes();
	}

	@Override
	public void setDefaultUsername(String username) {
		defaultUsername = username;
	}

	protected String getOutputFileName(byte[] input) {
		String inputString = new String(input);

		String outputType = "";
		if (inputString.startsWith("%PDF")) {
			outputType = "pdf";
		} else if (inputString.startsWith("<?xml ")) {
			outputType = "xml";
		} else {
			outputType = "txt";
		}

		return new Long(System.currentTimeMillis()).toString() + "."
				+ outputType;
	}

	protected byte[] prepareInput(byte[] input) {
		return input;
	}

	protected String getSftpHost(String userName) {
		return Configuration.getPluginOption(this, userName, "sftpHost");
	}

	protected Integer getSftpPort(String userName) {
		return Integer.parseInt(Configuration.getPluginOption(this, userName,
				"sftpPort"));
	}

	protected String getSftpUser(String userName) {
		return Configuration.getPluginOption(this, userName, "sftpUsername");
	}

	protected String getSftpPassword(String userName) {
		return Configuration.getPluginOption(this, userName, "sftpPassword");
	}

	protected String getSftpPath(String userName) {
		return Configuration.getPluginOption(this, userName, "sftpPath");
	}

}