2012-12-26 20:59:08 +04:00
|
|
|
<?php
|
2012-12-27 22:47:46 +04:00
|
|
|
/**
|
|
|
|
* Copyright (c) 2012 Henrik Kjölhede <hkjolhede@gmail.com>
|
|
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
|
|
* later.
|
|
|
|
* See the COPYING-README file.
|
|
|
|
*/
|
2013-02-09 18:57:33 +04:00
|
|
|
namespace OC\Files\Storage;
|
2012-12-27 22:47:46 +04:00
|
|
|
|
2012-12-28 00:00:20 +04:00
|
|
|
set_include_path(get_include_path() . PATH_SEPARATOR . OC_App::getAppPath('files_external') . '/3rdparty/phpseclib/phpseclib');
|
2012-12-26 20:59:08 +04:00
|
|
|
require('Net/SFTP.php');
|
|
|
|
|
2013-02-09 17:12:17 +04:00
|
|
|
class SFTP extends OC\Files\Storage\Common {
|
2012-12-27 02:38:17 +04:00
|
|
|
private $host;
|
2012-12-26 20:59:08 +04:00
|
|
|
private $user;
|
|
|
|
private $password;
|
|
|
|
private $root;
|
|
|
|
|
|
|
|
private $client;
|
|
|
|
|
|
|
|
private static $tempFiles = array();
|
|
|
|
|
|
|
|
public function __construct($params) {
|
|
|
|
$this->host = $params['host'];
|
|
|
|
$proto = strpos($this->host, '://');
|
|
|
|
if ($proto != false) {
|
|
|
|
$this->host = substr($this->host, $proto+3);
|
|
|
|
}
|
|
|
|
$this->user = $params['user'];
|
|
|
|
$this->password = $params['password'];
|
2013-01-26 22:46:23 +04:00
|
|
|
$this->root = isset($params['root']) ? $this->cleanPath($params['root']) : '/';
|
2012-12-26 20:59:08 +04:00
|
|
|
if ($this->root[0] != '/') $this->root = '/' . $this->root;
|
|
|
|
if (substr($this->root, -1, 1) != '/') $this->root .= '/';
|
|
|
|
|
2012-12-27 02:38:17 +04:00
|
|
|
$host_keys = $this->read_host_keys();
|
|
|
|
|
2012-12-26 20:59:08 +04:00
|
|
|
$this->client = new Net_SFTP($this->host);
|
|
|
|
if (!$this->client->login($this->user, $this->password)) {
|
2012-12-27 02:38:17 +04:00
|
|
|
throw new Exception('Login failed');
|
|
|
|
}
|
|
|
|
|
|
|
|
$current_host_key = $this->client->getServerPublicHostKey();
|
|
|
|
|
|
|
|
if (array_key_exists($this->host, $host_keys)) {
|
|
|
|
if ($host_keys[$this->host] != $current_host_key) {
|
|
|
|
throw new Exception('Host public key does not match known key');
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$host_keys[$this->host] = $current_host_key;
|
|
|
|
$this->write_host_keys($host_keys);
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
}
|
2012-12-29 01:22:04 +04:00
|
|
|
|
|
|
|
public function test() {
|
|
|
|
if (!isset($params['host']) || !isset($params['user']) || !isset($params['password'])) {
|
|
|
|
throw new Exception("Required parameters not set");
|
|
|
|
}
|
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
|
2012-12-27 02:38:17 +04:00
|
|
|
private function abs_path($path) {
|
2012-12-26 20:59:08 +04:00
|
|
|
return $this->root . $path;
|
|
|
|
}
|
|
|
|
|
2012-12-27 02:38:17 +04:00
|
|
|
private function host_keys_path() {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
$storage_view = \OCP\Files::getStorage('files_external');
|
|
|
|
if ($storage_view) {
|
|
|
|
return \OCP\Config::getSystemValue('datadirectory') .
|
|
|
|
$storage_view->getAbsolutePath('') .
|
|
|
|
'ssh_host_keys';
|
|
|
|
}
|
|
|
|
} catch (Exception $e) {
|
2012-12-27 02:38:17 +04:00
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
private function write_host_keys($keys) {
|
|
|
|
try {
|
|
|
|
$key_path = $this->host_keys_path();
|
|
|
|
$fp = fopen($key_path, 'w');
|
|
|
|
foreach ($keys as $host => $key) {
|
|
|
|
fwrite($fp, $host . '::' . $key . "\n");
|
|
|
|
}
|
|
|
|
fclose($fp);
|
|
|
|
return true;
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private function read_host_keys() {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
$key_path = $this->host_keys_path();
|
|
|
|
if (file_exists($key_path)) {
|
|
|
|
$hosts = array();
|
|
|
|
$keys = array();
|
|
|
|
$lines = file($key_path, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
|
|
|
|
if ($lines) {
|
|
|
|
foreach ($lines as $line) {
|
|
|
|
$host_key_arr = explode("::", $line, 2);
|
|
|
|
if (count($host_key_arr) == 2) {
|
|
|
|
$hosts[] = $host_key_arr[0];
|
|
|
|
$keys[] = $host_key_arr[1];
|
|
|
|
}
|
2012-12-27 02:38:17 +04:00
|
|
|
}
|
2012-12-27 02:49:53 +04:00
|
|
|
return array_combine($hosts, $keys);
|
2012-12-27 02:38:17 +04:00
|
|
|
}
|
|
|
|
}
|
2012-12-27 02:49:53 +04:00
|
|
|
} catch (Exception $e) {
|
2012-12-27 02:38:17 +04:00
|
|
|
}
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
2012-12-26 20:59:08 +04:00
|
|
|
public function mkdir($path) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
return $this->client->mkdir($this->abs_path($path));
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
public function rmdir($path) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
return $this->client->delete($this->abs_path($path), true);
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-28 00:00:20 +04:00
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
|
|
|
|
public function opendir($path) {
|
|
|
|
try {
|
2012-12-27 02:49:53 +04:00
|
|
|
$list = $this->client->nlist($this->abs_path($path));
|
|
|
|
|
2012-12-26 20:59:08 +04:00
|
|
|
$id = md5('sftp:' . $path);
|
2013-02-09 22:08:39 +04:00
|
|
|
$dir_stream = array();
|
2012-12-26 20:59:08 +04:00
|
|
|
foreach($list as $file) {
|
|
|
|
if ($file != '.' && $file != '..') {
|
2013-02-09 22:08:39 +04:00
|
|
|
$dir_stream[] = $file;
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
}
|
2013-02-09 22:08:39 +04:00
|
|
|
\OC\Files\Stream\Dir::register($id, $dir_stream);
|
2012-12-26 20:59:08 +04:00
|
|
|
return opendir('fakedir://' . $id);
|
|
|
|
} catch(Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public function filetype($path) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
$stat = $this->client->stat($this->abs_path($path));
|
|
|
|
if ($stat['type'] == NET_SFTP_TYPE_REGULAR) return 'file';
|
|
|
|
if ($stat['type'] == NET_SFTP_TYPE_DIRECTORY) return 'dir';
|
|
|
|
} catch (Exeption $e) {
|
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function isReadable($path) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function isUpdatable($path) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function file_exists($path) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
return $this->client->stat($this->abs_path($path)) === false ? false : true;
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
public function unlink($path) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
return $this->client->delete($this->abs_path($path), true);
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
public function fopen($path, $mode) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
$abs_path = $this->abs_path($path);
|
|
|
|
switch($mode) {
|
|
|
|
case 'r':
|
|
|
|
case 'rb':
|
|
|
|
if ( !$this->file_exists($path)) return false;
|
|
|
|
if (strrpos($path, '.')!==false) {
|
|
|
|
$ext=substr($path, strrpos($path, '.'));
|
|
|
|
} else {
|
|
|
|
$ext='';
|
|
|
|
}
|
|
|
|
$tmp = OC_Helper::tmpFile($ext);
|
|
|
|
$this->getFile($abs_path, $tmp);
|
|
|
|
return fopen($tmp, $mode);
|
2012-12-26 20:59:08 +04:00
|
|
|
|
2012-12-27 02:49:53 +04:00
|
|
|
case 'w':
|
|
|
|
case 'wb':
|
|
|
|
case 'a':
|
|
|
|
case 'ab':
|
|
|
|
case 'r+':
|
|
|
|
case 'w+':
|
|
|
|
case 'wb+':
|
|
|
|
case 'a+':
|
|
|
|
case 'x':
|
|
|
|
case 'x+':
|
|
|
|
case 'c':
|
|
|
|
case 'c+':
|
|
|
|
if (strrpos($path, '.')!==false) {
|
|
|
|
$ext=substr($path, strrpos($path, '.'));
|
|
|
|
} else {
|
|
|
|
$ext='';
|
|
|
|
}
|
|
|
|
$tmpFile=OC_Helper::tmpFile($ext);
|
2013-02-09 23:35:48 +04:00
|
|
|
\OC\Files\Stream\Close::registerCallback($tmpFile, array($this, 'writeBack'));
|
2012-12-27 02:49:53 +04:00
|
|
|
if ($this->file_exists($path)) {
|
|
|
|
$this->getFile($abs_path, $tmpFile);
|
|
|
|
}
|
|
|
|
self::$tempFiles[$tmpFile]=$abs_path;
|
|
|
|
return fopen('close://'.$tmpFile, $mode);
|
|
|
|
}
|
|
|
|
} catch (Exception $e) {
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function writeBack($tmpFile) {
|
|
|
|
if (array_key_exists($tmpFile, self::$tempFiles)) {
|
|
|
|
$this->uploadFile($tmpFile, self::$tempFiles[$tmpFile]);
|
|
|
|
unlink($tmpFile);
|
|
|
|
unset(self::$tempFiles[$tmpFile]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public function free_space($path) {
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function touch($path, $mtime=null) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
2013-02-10 02:33:01 +04:00
|
|
|
if (!is_null($mtime)) return false;
|
2012-12-27 02:49:53 +04:00
|
|
|
if (!$this->file_exists($path)) {
|
|
|
|
$this->client->put($this->abs_path($path), '');
|
2013-02-10 02:29:58 +04:00
|
|
|
} else {
|
|
|
|
return false;
|
2012-12-27 02:49:53 +04:00
|
|
|
}
|
|
|
|
} catch (Exception $e) {
|
2013-02-10 02:29:58 +04:00
|
|
|
return false;
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
2013-02-10 02:29:58 +04:00
|
|
|
return true;
|
2012-12-26 20:59:08 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
public function getFile($path, $target) {
|
|
|
|
$this->client->get($path, $target);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function uploadFile($path, $target) {
|
|
|
|
$this->client->put($target, $path, NET_SFTP_LOCAL_FILE);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function rename($source, $target) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
return $this->client->rename($this->abs_path($source), $this->abs_path($target));
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-28 00:00:20 +04:00
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
|
|
|
|
public function stat($path) {
|
2012-12-27 02:49:53 +04:00
|
|
|
try {
|
|
|
|
$stat = $this->client->stat($this->abs_path($path));
|
|
|
|
|
|
|
|
$mtime = $stat ? $stat['mtime'] : -1;
|
|
|
|
$size = $stat ? $stat['size'] : 0;
|
2012-12-26 20:59:08 +04:00
|
|
|
|
2012-12-27 02:49:53 +04:00
|
|
|
return array('mtime' => $mtime, 'size' => $size, 'ctime' => -1);
|
|
|
|
} catch (Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
2012-12-26 20:59:08 +04:00
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
?>
|