/* Title: Pure/General/ssh.scala
Author: Makarius
SSH client based on JSch (see also http://www.jcraft.com/jsch/examples).
*/
package isabelle
import java.io.{InputStream, OutputStream, ByteArrayOutputStream}
import scala.collection.{mutable, JavaConversions}
import com.jcraft.jsch.{JSch, Logger => JSch_Logger, Session => JSch_Session, SftpException,
OpenSSHConfig, UserInfo, Channel => JSch_Channel, ChannelExec, ChannelSftp, SftpATTRS}
object SSH
{
/* target machine: user@host syntax */
object Target
{
val Pattern = "^([^@]+)@(.+)$".r
def parse(s: String): (String, String) =
s match {
case Pattern(user, host) => (user, host)
case _ => ("", s)
}
def unapplySeq(s: String): Option[List[String]] =
parse(s) match {
case (_, "") => None
case (user, host) => Some(List(user, host))
}
}
val default_port = 22
/* init */
def init(options: Options): SSH =
{
val config_dir = Path.explode(options.string("ssh_config_dir"))
if (!config_dir.is_dir) error("Bad ssh config directory: " + config_dir)
val jsch = new JSch
val config_file = Path.explode(options.string("ssh_config_file"))
if (config_file.is_file)
jsch.setConfigRepository(OpenSSHConfig.parseFile(File.platform_path(config_file)))
val known_hosts = config_dir + Path.explode("known_hosts")
if (!known_hosts.is_file) known_hosts.file.createNewFile
jsch.setKnownHosts(File.platform_path(known_hosts))
val identity_files =
Library.space_explode(':', options.string("ssh_identity_files")).map(Path.explode(_))
for (identity_file <- identity_files if identity_file.is_file)
jsch.addIdentity(File.platform_path(identity_file))
new SSH(options, jsch)
}
def connect_timeout(options: Options): Int =
options.seconds("ssh_connect_timeout").ms.toInt
/* logging */
def logging(verbose: Boolean = true, debug: Boolean = false)
{
JSch.setLogger(if (verbose) new Logger(debug) else null)
}
private class Logger(debug: Boolean) extends JSch_Logger
{
def isEnabled(level: Int): Boolean = level != JSch_Logger.DEBUG || debug
def log(level: Int, msg: String)
{
level match {
case JSch_Logger.ERROR | JSch_Logger.FATAL => Output.error_message(msg)
case JSch_Logger.WARN => Output.warning(msg)
case _ => Output.writeln(msg)
}
}
}
/* user info */
object No_User_Info extends UserInfo
{
def getPassphrase: String = null
def getPassword: String = null
def promptPassword(msg: String): Boolean = false
def promptPassphrase(msg: String): Boolean = false
def promptYesNo(msg: String): Boolean = false
def showMessage(msg: String): Unit = Output.writeln(msg)
}
/* channel */
class Channel[C <: JSch_Channel] private[SSH](
val session: Session, val kind: String, val channel: C)
{
override def toString: String = kind + " " + session.toString
def close() { channel.disconnect }
}
/* Sftp channel */
type Attrs = SftpATTRS
sealed case class Dir_Entry(name: Path, attrs: Attrs)
{
def is_file: Boolean = attrs.isReg
def is_dir: Boolean = attrs.isDir
}
class Sftp private[SSH](session: Session, kind: String, channel: ChannelSftp)
extends Channel[ChannelSftp](session, kind, channel)
{
channel.connect(connect_timeout(session.options))
val settings: Map[String, String] =
{
val home = channel.getHome
Map("HOME" -> home, "USER_HOME" -> home)
}
def expand_path(path: Path): Path = path.expand_env(settings)
def remote_path(path: Path): String = expand_path(path).implode
def chmod(permissions: Int, path: Path): Unit = channel.chmod(permissions, remote_path(path))
def mv(path1: Path, path2: Path): Unit = channel.rename(remote_path(path1), remote_path(path2))
def rm(path: Path): Unit = channel.rm(remote_path(path))
def mkdir(path: Path): Unit = channel.mkdir(remote_path(path))
def rmdir(path: Path): Unit = channel.rmdir(remote_path(path))
def stat(path: Path): Option[Dir_Entry] =
try { Some(Dir_Entry(expand_path(path), channel.stat(remote_path(path)))) }
catch { case _: SftpException => None }
def is_file(path: Path): Boolean = stat(path).map(_.is_file) getOrElse false
def is_dir(path: Path): Boolean = stat(path).map(_.is_dir) getOrElse false
def read_dir(path: Path): List[Dir_Entry] =
{
val dir = channel.ls(remote_path(path))
(for {
i <- (0 until dir.size).iterator
a = dir.get(i).asInstanceOf[AnyRef]
name = Untyped.get[String](a, "filename")
attrs = Untyped.get[Attrs](a, "attrs")
if name != "." && name != ".."
} yield Dir_Entry(Path.basic(name), attrs)).toList
}
def find_files(root: Path, pred: Dir_Entry => Boolean = _ => true): List[Dir_Entry] =
{
def find(dir: Path): List[Dir_Entry] =
read_dir(dir).flatMap(entry =>
{
val file = dir + entry.name
if (entry.is_dir) find(file)
else if (pred(entry)) List(entry.copy(name = file))
else Nil
})
find(root)
}
def open_input(path: Path): InputStream = channel.get(remote_path(path))
def open_output(path: Path): OutputStream = channel.put(remote_path(path))
def read_file(path: Path, local_path: Path): Unit =
channel.get(remote_path(path), File.platform_path(local_path))
def read_bytes(path: Path): Bytes = using(open_input(path))(Bytes.read_stream(_))
def read(path: Path): String = using(open_input(path))(File.read_stream(_))
def write_file(path: Path, local_path: Path): Unit =
channel.put(File.platform_path(local_path), remote_path(path))
def write_bytes(path: Path, bytes: Bytes): Unit =
using(open_output(path))(bytes.write_stream(_))
def write(path: Path, text: String): Unit =
using(open_output(path))(stream => Bytes(text).write_stream(stream))
}
/* exec channel */
private val exec_wait_delay = Time.seconds(0.3)
class Exec private[SSH](session: Session, kind: String, channel: ChannelExec)
extends Channel[ChannelExec](session, kind, channel)
{
def kill(signal: String) { channel.sendSignal(signal) }
val exit_status: Future[Int] =
Future.thread("ssh_wait") {
while (!channel.isClosed) Thread.sleep(exec_wait_delay.ms)
channel.getExitStatus
}
val stdin: OutputStream = channel.getOutputStream
val stdout: InputStream = channel.getInputStream
val stderr: InputStream = channel.getErrStream
// connect after preparing streams
channel.connect(connect_timeout(session.options))
def result(
progress_stdout: String => Unit = (_: String) => (),
progress_stderr: String => Unit = (_: String) => (),
strict: Boolean = true): Process_Result =
{
stdin.close
def read_lines(stream: InputStream, progress: String => Unit): List[String] =
{
val result = new mutable.ListBuffer[String]
val line_buffer = new ByteArrayOutputStream(100)
def line_flush()
{
val line = line_buffer.toString(UTF8.charset_name)
progress(line)
result += line
line_buffer.reset
}
var c = 0
var finished = false
while (!finished) {
while ({ c = stream.read; c != -1 && c != 10 }) line_buffer.write(c)
if (c == 10) line_flush()
else if (channel.isClosed) {
if (line_buffer.size > 0) line_flush()
finished = true
}
else Thread.sleep(exec_wait_delay.ms)
}
result.toList
}
val out_lines = Future.thread("ssh_stdout") { read_lines(stdout, progress_stdout) }
val err_lines = Future.thread("ssh_stderr") { read_lines(stderr, progress_stderr) }
def terminate()
{
close
out_lines.join
err_lines.join
exit_status.join
}
val rc =
try { exit_status.join }
catch { case Exn.Interrupt() => terminate(); Exn.Interrupt.return_code }
close
if (strict && rc == Exn.Interrupt.return_code) throw Exn.Interrupt()
Process_Result(rc, out_lines.join, err_lines.join)
}
}
/* session */
class Session private[SSH](val options: Options, val session: JSch_Session)
{
def update_options(new_options: Options): Session = new Session(new_options, session)
override def toString: String =
(if (session.getUserName == null) "" else session.getUserName + "@") +
(if (session.getHost == null) "" else session.getHost) +
(if (session.getPort == default_port) "" else ":" + session.getPort) +
(if (session.isConnected) "" else " (disconnected)")
def close() { session.disconnect }
def sftp(): Sftp =
{
val kind = "sftp"
val channel = session.openChannel(kind).asInstanceOf[ChannelSftp]
new Sftp(this, kind, channel)
}
def exec(command: String): Exec =
{
val kind = "exec"
val channel = session.openChannel(kind).asInstanceOf[ChannelExec]
channel.setCommand("export USER_HOME=\"$HOME\"\n" + command)
new Exec(this, kind, channel)
}
def execute(command: String,
progress_stdout: String => Unit = (_: String) => (),
progress_stderr: String => Unit = (_: String) => (),
strict: Boolean = true): Process_Result =
exec(command).result(progress_stdout, progress_stderr, strict)
/* tmp dirs */
def rm_tree(remote_dir: String): Unit =
execute("rm -r -f " + File.bash_string(remote_dir)).check
def tmp_dir(): String =
execute("mktemp -d -t tmp.XXXXXXXXXX").check.out
def with_tmp_dir[A](body: Path => A): A =
{
val remote_dir = tmp_dir()
try { body(Path.explode(remote_dir)) } finally { rm_tree(remote_dir) }
}
}
}
class SSH private(val options: Options, val jsch: JSch)
{
def update_options(new_options: Options): SSH = new SSH(new_options, jsch)
def open_session(host: String, user: String = "", port: Int = SSH.default_port): SSH.Session =
{
val session = jsch.getSession(if (user == "") null else user, host, port)
session.setUserInfo(SSH.No_User_Info)
session.setConfig("MaxAuthTries", "3")
if (options.bool("ssh_compression")) {
session.setConfig("compression.s2c", "zlib@openssh.com,zlib,none")
session.setConfig("compression.c2s", "zlib@openssh.com,zlib,none")
session.setConfig("compression_level", "9")
}
session.connect(SSH.connect_timeout(options))
new SSH.Session(options, session)
}
}