2012-03-22 18:56:19 +00:00
< ? php
/**
* Copyright ( c ) 2012 Robin Appelman < icewind @ owncloud . com >
* This file is licensed under the Affero General Public License version 3 or
* later .
* See the COPYING - README file .
*/
2012-09-07 16:30:48 +00:00
namespace OC\Files\Storage ;
class FTP extends \OC\Files\Storage\StreamWrapper {
2012-03-22 18:56:19 +00:00
private $password ;
private $user ;
private $host ;
private $secure ;
private $root ;
private static $tempFiles = array ();
2012-08-29 06:42:49 +00:00
2013-03-08 17:15:20 +00:00
/**
* check if php - ftp is installed
*/
public static function checkDependencies () {
if ( function_exists ( 'ftp_login' )) {
return ( true );
} else {
$l = new \OC_L10N ( 'files_external' );
2013-05-30 15:37:47 +00:00
return $l -> t ( '<b>Note:</b> The FTP support in PHP is not enabled or installed. Mounting of FTP shares is not possible. Please ask your system administrator to install it.' );
2013-03-08 17:15:20 +00:00
}
}
2012-09-07 13:22:01 +00:00
public function __construct ( $params ) {
2012-12-24 18:45:52 +00:00
if ( isset ( $params [ 'host' ]) && isset ( $params [ 'user' ]) && isset ( $params [ 'password' ])) {
$this -> host = $params [ 'host' ];
$this -> user = $params [ 'user' ];
$this -> password = $params [ 'password' ];
if ( isset ( $params [ 'secure' ])) {
if ( is_string ( $params [ 'secure' ])) {
$this -> secure = ( $params [ 'secure' ] === 'true' );
} else {
$this -> secure = ( bool ) $params [ 'secure' ];
}
2012-11-30 15:27:11 +00:00
} else {
2012-12-24 18:45:52 +00:00
$this -> secure = false ;
}
$this -> root = isset ( $params [ 'root' ]) ? $params [ 'root' ] : '/' ;
if ( ! $this -> root || $this -> root [ 0 ] != '/' ) {
$this -> root = '/' . $this -> root ;
}
2013-11-28 10:45:26 +00:00
if ( substr ( $this -> root , - 1 ) !== '/' ) {
$this -> root .= '/' ;
}
2012-11-30 15:27:11 +00:00
} else {
2013-02-12 01:27:05 +00:00
throw new \Exception ();
2012-07-27 16:32:03 +00:00
}
2012-12-24 18:45:52 +00:00
2012-03-22 18:56:19 +00:00
}
2012-10-11 21:06:57 +00:00
public function getId (){
return 'ftp::' . $this -> user . '@' . $this -> host . '/' . $this -> root ;
}
2012-03-22 18:56:19 +00:00
/**
* construct the ftp url
2012-10-11 21:17:59 +00:00
* @ param string $path
2012-03-22 18:56:19 +00:00
* @ return string
*/
2012-09-07 13:22:01 +00:00
public function constructUrl ( $path ) {
2012-03-22 18:56:19 +00:00
$url = 'ftp' ;
2012-11-30 15:27:11 +00:00
if ( $this -> secure ) {
2012-03-22 18:56:19 +00:00
$url .= 's' ;
}
$url .= '://' . $this -> user . ':' . $this -> password . '@' . $this -> host . $this -> root . $path ;
return $url ;
}
2013-11-29 11:58:57 +00:00
/**
* Unlinks file or directory
* @ param string @ path
*/
public function unlink ( $path ) {
if ( $this -> is_dir ( $path )) {
return $this -> rmdir ( $path );
}
else {
$url = $this -> constructUrl ( $path );
$result = unlink ( $url );
clearstatcache ( true , $url );
return $result ;
}
}
2012-09-07 13:22:01 +00:00
public function fopen ( $path , $mode ) {
switch ( $mode ) {
2012-03-22 18:56:19 +00:00
case 'r' :
case 'rb' :
case 'w' :
case 'wb' :
case 'a' :
case 'ab' :
//these are supported by the wrapper
$context = stream_context_create ( array ( 'ftp' => array ( 'overwrite' => true )));
2013-02-09 16:35:47 +00:00
return fopen ( $this -> constructUrl ( $path ), $mode , false , $context );
2012-03-22 18:56:19 +00:00
case 'r+' :
case 'w+' :
case 'wb+' :
case 'a+' :
case 'x' :
case 'x+' :
case 'c' :
case 'c+' :
//emulate these
2012-11-30 15:27:11 +00:00
if ( strrpos ( $path , '.' ) !== false ) {
2012-11-04 10:10:46 +00:00
$ext = substr ( $path , strrpos ( $path , '.' ));
2012-11-30 15:27:11 +00:00
} else {
2012-03-22 18:56:19 +00:00
$ext = '' ;
}
2013-02-12 10:00:38 +00:00
$tmpFile = \OCP\Files :: tmpFile ( $ext );
2013-01-28 14:34:15 +00:00
\OC\Files\Stream\Close :: registerCallback ( $tmpFile , array ( $this , 'writeBack' ));
2012-11-30 15:27:11 +00:00
if ( $this -> file_exists ( $path )) {
2012-11-02 18:53:02 +00:00
$this -> getFile ( $path , $tmpFile );
2012-03-22 18:56:19 +00:00
}
self :: $tempFiles [ $tmpFile ] = $path ;
2013-02-09 16:35:47 +00:00
return fopen ( 'close://' . $tmpFile , $mode );
2012-03-22 18:56:19 +00:00
}
2012-10-11 21:17:59 +00:00
return false ;
2012-03-22 18:56:19 +00:00
}
2012-09-07 13:22:01 +00:00
public function writeBack ( $tmpFile ) {
2012-11-30 15:27:11 +00:00
if ( isset ( self :: $tempFiles [ $tmpFile ])) {
2012-10-23 20:53:54 +00:00
$this -> uploadFile ( $tmpFile , self :: $tempFiles [ $tmpFile ]);
2012-03-22 18:56:19 +00:00
unlink ( $tmpFile );
}
}
}