antville/helma
antville/helma
1
1
Fork 0
Code Issues 5 Pull requests 5 Projects Releases 5 Activity Actions

* added JsDoc compatible inline documentation

Browse source
This commit is contained in:
grob 2007-01-30 17:31:52 +00:00
parent 14ee73a230
commit 9a4401d6c4
1 changed files with 102 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

163
helma/Ssh.js
View file

@ -8,24 +8,39 @@
* *
* Copyright 1998-2006 Helma Software. All Rights Reserved. * Copyright 1998-2006 Helma Software. All Rights Reserved.
* *
* $RCSfile: helma.Ssh.js,v $ * $RCSfile: Ssh.js,v $
* $Author: czv $ * $Author: czv $
* $Revision: 1.4 $ * $Revision: 1.2 $
* $Date: 2006/04/18 13:06:58 $ * $Date: 2006/04/24 07:02:17 $
*/ */
/**
* @fileoverview Fields and methods of the helma.Ssh class.
*/
// take care of any dependencies // take care of any dependencies
app.addRepository('modules/helma/File.js'); app.addRepository('modules/helma/File.js');
app.addRepository('modules/helma/ganymed-ssh2.jar'); app.addRepository('modules/helma/ganymed-ssh2.jar');
// define the helma namespace, if not existing
if (!global.helma) { if (!global.helma) {
global.helma = {}; global.helma = {};
} }
/** /**
* constructor * Creates a new instance of helma.Ssh
* @class This class provides methods for connecting to a remote
* server via secure shell (ssh) and copying files from/to a remote
* server using secure copy (scp). It utilizes "Ganymed SSH-2 for Java"
* (see <a href="http://www.ganymed.ethz.ch/ssh2/">http://www.ganymed.ethz.ch/ssh2/</a>).
* @param {String} server The server to connect to
* @param {helma.File|java.io.File|String} hosts Either a file
* containing a list of known hosts, or the path pointing to a
* file. This argument is optional.
* @constructor
* @returns A newly created instance of helma.Ssh
* @author Robert Gaggl <robert@nomatic.org>
*/ */
helma.Ssh = function(server, hosts) { helma.Ssh = function(server, hosts) {
var SSHPKG = Packages.ch.ethz.ssh2; var SSHPKG = Packages.ch.ethz.ssh2;
@ -36,6 +51,7 @@ helma.Ssh = function(server, hosts) {
var verifier = null; var verifier = null;
var knownHosts, connection; var knownHosts, connection;
// check if necessary jar file is in classpath
try { try {
knownHosts = new SSHPKG.KnownHosts(); knownHosts = new SSHPKG.KnownHosts();
connection = new SSHPKG.Connection(server); connection = new SSHPKG.Connection(server);
@ -47,6 +63,10 @@ helma.Ssh = function(server, hosts) {
"[" + SSHPKGURL + "]"); "[" + SSHPKGURL + "]");
} }
/**
* A simple verifier for verifying host keys
* @private
*/
var SimpleVerifier = { var SimpleVerifier = {
verifyServerHostKey: function(hostname, port, serverHostKeyAlgorithm, serverHostKey) { verifyServerHostKey: function(hostname, port, serverHostKeyAlgorithm, serverHostKey) {
var result = knownHosts.verifyHostkey(hostname, serverHostKeyAlgorithm, serverHostKey); var result = knownHosts.verifyHostkey(hostname, serverHostKeyAlgorithm, serverHostKey);
@ -75,24 +95,28 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* private method for creating an instance of * Converts the argument into an instance of java.io.File
* java.io.File based on various argument types * @param {helma.File|java.io.File|String} file Either a file
* @param a String or an instance of helma.File or java.io.File * object or the path to a file as string
* @returns The argument converted into a file object
* @type java.io.File
* @private
*/ */
var getFile = function(arg) { var getFile = function(file) {
if (arg instanceof helma.File) { if (file instanceof helma.File) {
return new java.io.File(arg.getAbsolutePath()); return new java.io.File(file.getAbsolutePath());
} else if (arg instanceof java.io.File) { } else if (file instanceof java.io.File) {
return arg; return file;
} else if (arg.constructor == String) { } else if (file.constructor == String) {
return new java.io.File(arg); return new java.io.File(file);
} }
return null; return null;
}; };
/** /**
* private method that connects to the remote server * Connects to the remote server
* @return Boolean * @return Boolean
* @private
*/ */
var connect = function() { var connect = function() {
try { try {
@ -106,31 +130,37 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* debug output method * Private helper method for debugging output using app.logger
* @param String name of method * @param {String} methodName The name of the method
* @param String debug message * @param {String} msg The debug message to write to event log file
* @private
*/ */
var debug = function(methodName, msg) { var debug = function(methodName, msg) {
var msg = msg ? " " + msg : ""; var msg = msg ? " " + msg : "";
app.debug(className + ":" + methodName + msg); app.logger.debug(className + ":" + methodName + msg);
return; return;
}; };
/** /**
* error output method * Private helper method for error output using app.logger
* @param String name of method * @param {String} methodName The name of the method
* @param String error message * @param {String} msg The error message to write to event log file
* @private
*/ */
var error = function(methodName, msg) { var error = function(methodName, msg) {
var tx = java.lang.Thread.currentThread(); var tx = java.lang.Thread.currentThread();
tx.dumpStack(); tx.dumpStack();
app.log("Error in " + className + ":" + methodName + ": " + msg); app.logger.error(className + ":" + methodName + ": " + msg);
return; return;
}; };
/** /**
* reads a known hosts file * Opens the file passed as argument and adds the known hosts
* @param Object String or instance of helma.File or java.io.File * therein to the list of known hosts for this client.
* @param {helma.File|java.io.File|String} file Either a file object
* or the path to a file containing a list of known hosts
* @returns True if adding the list was successful, false otherwise
* @type Boolean
*/ */
this.addKnownHosts = function(file) { this.addKnownHosts = function(file) {
try { try {
@ -144,10 +174,11 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* connects to a remote host with username/password authentication * Connects to a remote host using plain username/password authentication.
* @param String username * @param {String} username The username
* @param String password * @param {String} password The password
* @return Boolean * @returns True in case the connection attempt was successful, false otherwise.
* @type Boolean
*/ */
this.connect = function(username, password) { this.connect = function(username, password) {
if (!username || !password) { if (!username || !password) {
@ -162,11 +193,14 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* connects to a remote host using private key and passphrase * Connects to a remote host using a private key and the corresponding
* @param String username * passphrase.
* @param String path to keyfile * @param {String} username The username
* @param String passphrase (if needed by key) * @param {helma.File|java.io.File|String} key Either a file object
* @return Boolean * representing the private key file, or the path to it.
* @param {String} passphrase The passphrase of the private key, if necessary.
* @returns True in case the connection attempt was successful, false otherwise.
* @type Boolean
*/ */
this.connectWithKey = function(username, key, passphrase) { this.connectWithKey = function(username, key, passphrase) {
var keyFile; var keyFile;
@ -182,7 +216,7 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* disconnect a session * Disconnects this client from the remote server.
*/ */
this.disconnect = function() { this.disconnect = function() {
connection.close(); connection.close();
@ -191,22 +225,24 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* returns true if the ssh client is connected * Returns true if this client is currently connected.
* @return Boolean * @returns True in case this client is connected, false otherwise.
* @type Boolean
*/ */
this.isConnected = function() { this.isConnected = function() {
return (connection != null && connection.isAuthenticationComplete()); return (connection != null && connection.isAuthenticationComplete());
}; };
/** /**
* copies a file to the remote server * Copies a local file to the remote server
* @param String path to local file that should be copied * @param {String|Array} localFile Either the path to a single local
* to remote server. If the argument is a * file or an array containing multiple file paths that should be
* String Array, all files specified in the * copied to the remote server.
* Array are copied to the server * @param {String} remoteDir The path to the remote destination directory
* @param String path to remote destination directory * @param {String} mode An optional 4-digit permission mode string (eg.
* @param String (optional) 4-digit permission mode string (eg. "0755"); * <code>0755</code>);
* @return Boolean * @returns True in case the operation was successful, false otherwise.
* @type Boolean
*/ */
this.put = function(localFile, remoteDir, mode) { this.put = function(localFile, remoteDir, mode) {
if (!localFile || !remoteDir) { if (!localFile || !remoteDir) {
@ -230,13 +266,13 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* copies a file from the remote server. * Retrieves a file from the remote server and stores it locally.
* @param String path to remote file that should be copied * @param {String|Array} remoteFile Either the path to a single remote
* to remote server. If the argument is a * file or an array containing multiple file paths that should be
* String Array, all files specified in the * copied onto the local disk.
* Array are copied from the remote server * @param {String} targetDir The path to the local destination directory
* @param String path to local destination directory * @returns True if the copy process was successful, false otherwise.
* @return Boolean * @type Boolean
*/ */
this.get = function(remoteFile, targetDir) { this.get = function(remoteFile, targetDir) {
if (!remoteFile || !targetDir) { if (!remoteFile || !targetDir) {
@ -257,10 +293,10 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* executes a command on the remote server * Executes a single command on the remote server.
* (scp must be in PATH on the remote server) * @param {String} cmd The command to execute on the remote server.
* @param String the command to execute * @return The result of the command execution
* @return String result of the command * @type String
*/ */
this.execCommand = function(cmd) { this.execCommand = function(cmd) {
if (!this.isConnected()) { if (!this.isConnected()) {
@ -288,17 +324,21 @@ helma.Ssh = function(server, hosts) {
}; };
/** /**
* toggle paranoia mode * Toggles paranoid mode. If set to true this client tries to
* @param Boolean * verify the host key against the its list of known hosts
* during connection and rejects if the host key is not found
* therein or is different.
* @param {Boolean} p Either true or false
*/ */
this.setParanoid = function(p) { this.setParanoid = function(p) {
paranoid = (p == true) ? true : false; paranoid = (p === true);
return; return;
}; };
/** /**
* returns true if in paranoid mode * Returns true if this client is in paranoid mode.
* @return Boolean * @return Boolean
* @see #setParanoid
*/ */
this.isParanoid = function() { this.isParanoid = function() {
return paranoid; return paranoid;
@ -317,6 +357,7 @@ helma.Ssh = function(server, hosts) {
}; };
/** @ignore */
helma.Ssh.toString = function() { helma.Ssh.toString = function() {
return "[helma.Ssh]"; return "[helma.Ssh]";
}; };