diff options
Diffstat (limited to 'buildscripts/phing/classes/phing/tasks/ext/SshTask.php')
| -rw-r--r-- | buildscripts/phing/classes/phing/tasks/ext/SshTask.php | 224 |
1 files changed, 224 insertions, 0 deletions
diff --git a/buildscripts/phing/classes/phing/tasks/ext/SshTask.php b/buildscripts/phing/classes/phing/tasks/ext/SshTask.php new file mode 100644 index 00000000..9c2349a8 --- /dev/null +++ b/buildscripts/phing/classes/phing/tasks/ext/SshTask.php @@ -0,0 +1,224 @@ +<?php +/* + * $Id: e0fe77ed287d359bd7449d459769370e6192417f $ + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * This software consists of voluntary contributions made by many individuals + * and is licensed under the LGPL. For more information please see + * <http://phing.info>. + */ + +require_once 'phing/Task.php'; + +/** + * Execute commands on a remote host using ssh. + * + * @author Johan Van den Brande <johan@vandenbrande.com> + * @version $Id: e0fe77ed287d359bd7449d459769370e6192417f $ + * @package phing.tasks.ext + */ +class SshTask extends Task { + + private $host = ""; + private $port = 22; + private $username = ""; + private $password = ""; + private $command = ""; + private $pubkeyfile = ''; + private $privkeyfile = ''; + private $privkeyfilepassphrase = ''; + + /** + * The name of the property to capture (any) output of the command + * @var string + */ + private $property = ""; + + /** + * Whether to display the output of the command + * @var boolean + */ + private $display = true; + + public function setHost($host) + { + $this->host = $host; + } + + public function getHost() + { + return $this->host; + } + + public function setPort($port) + { + $this->port = $port; + } + + public function getPort() + { + return $this->port; + } + + public function setUsername($username) + { + $this->username = $username; + } + + public function getUsername() + { + return $this->username; + } + + public function setPassword($password) + { + $this->password = $password; + } + + public function getPassword() + { + return $this->password; + } + + /** + * Sets the public key file of the user to scp + */ + public function setPubkeyfile($pubkeyfile) + { + $this->pubkeyfile = $pubkeyfile; + } + + /** + * Returns the pubkeyfile + */ + public function getPubkeyfile() + { + return $this->pubkeyfile; + } + + /** + * Sets the private key file of the user to scp + */ + public function setPrivkeyfile($privkeyfile) + { + $this->privkeyfile = $privkeyfile; + } + + /** + * Returns the private keyfile + */ + public function getPrivkeyfile() + { + return $this->privkeyfile; + } + + /** + * Sets the private key file passphrase of the user to scp + */ + public function setPrivkeyfilepassphrase($privkeyfilepassphrase) + { + $this->privkeyfilepassphrase = $privkeyfilepassphrase; + } + + /** + * Returns the private keyfile passphrase + */ + public function getPrivkeyfilepassphrase($privkeyfilepassphrase) + { + return $this->privkeyfilepassphrase; + } + + public function setCommand($command) + { + $this->command = $command; + } + + public function getCommand() + { + return $this->command; + } + + /** + * Sets the name of the property to capture (any) output of the command + * @param string $property + */ + public function setProperty($property) + { + $this->property = $property; + } + + /** + * Sets whether to display the output of the command + * @param boolean $display + */ + public function setDisplay($display) + { + $this->display = (boolean) $display; + } + + public function init() + { + } + + public function main() + { + if (!function_exists('ssh2_connect')) { + throw new BuildException("To use SshTask, you need to install the PHP SSH2 extension."); + } + + $this->connection = ssh2_connect($this->host, $this->port); + if (is_null($this->connection)) { + throw new BuildException("Could not establish connection to " . $this->host . ":" . $this->port . "!"); + } + + $could_auth = null; + if ( $this->pubkeyfile ) { + $could_auth = ssh2_auth_pubkey_file($this->connection, $this->username, $this->pubkeyfile, $this->privkeyfile, $this->privkeyfilepassphrase); + } else { + $could_auth = ssh2_auth_password($this->connection, $this->username, $this->password); + } + if (!$could_auth) { + throw new BuildException("Could not authenticate connection!"); + } + + $stream = ssh2_exec($this->connection, $this->command); + if (!$stream) { + throw new BuildException("Could not execute command!"); + } + + $this->log("Executing command {$this->command}", Project::MSG_VERBOSE); + + stream_set_blocking($stream, true); + $result = stream_get_contents($stream); + + if (!strlen($result)) { + $stderr_stream = ssh2_fetch_stream($stream, SSH2_STREAM_STDERR); + stream_set_blocking($stderr_stream, true); + $result = stream_get_contents($stderr_stream); + } + + if ($this->display) { + print($result); + } + + if (!empty($this->property)) { + $this->project->setProperty($this->property, $result); + } + + fclose($stream); + if (isset($stderr_stream)) { + fclose($stderr_stream); + } + } +} |