File Source for FTPHost.class.php

<?php
/**
* @package communication
*/
/**
* Including various functions to manipulate arrays.
*/
require_once( CLASSPATH."core/Arrays.class.php" );
/**
*
*/
include_once( CLASSPATH."filesystem/Files.class.php" );
/**
* @see http://www.php.net/manual/en/function.ftp-chmod.php#66456
*/
if ( !function_exists('ftp_chmod') )
{
/**
* Sets the permissions on the specified remote file to mode.
*
* @author rabin at rab dot in
*
* @param resource $ftp_stream
* @param int $mode
* @param string $filename
*
* @return boolean
*/
function ftp_chmod($ftp_stream, $mode, $filename)
{
if ( is_int( $mode ) )
{
return ftp_site(
$ftp_stream,
sprintf('CHMOD %o %s', $mode, $filename)
);
}
else
{
return ftp_site(
$ftp_stream,
sprintf('CHMOD %u %s', $mode, $filename)
);
}
}
}
/**
* @package communication
*
* @version 0.2.15
* @todo Functions
* file_exists()
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (C) 2005 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class FTPHost
{
/**
* The Name of the databasehost.
*
* @var string $name
* @access public
*/
var $name;
/**
* The connection's port.
*
* @var int $port
* @access public
*/
var $port;
/**
* The username to log on the ftp server.
*
* @var string $user
* @access public
*/
var $user;
/**
* The password to log on the ftp server.
*
* @var string $password
* @access public
*/
var $password;
/**
* The connection's state of the ftp host.
*
* @var boolean $is_connected
* @access private
*/
var $is_connected = false;
/**
* Constructor
*
* @access public
* @version 1.1
* @since 0.1.0
*
* @param string $host
* @param string $user
* @param string $password
* @param string $port
*
* @return FTPHost
*/
function FTPHost( $host, $user, $password, $port = 21 )
{
$this->name = $host;
$this->user = $user;
$this->password = $password;
$this->port = $port;
}
/**
* Attempts to change the mode of the specified file to that given in mode.
*
* @access public
* @version 1.0
* @since 0.2.15
*
* @param string $str_path
* @param string $str_mod
* @param string $disconnect
*
* @return boolean
*/
function chmod( $str_path, $str_mod, $disconnect = true )
{
if ( !$this->is_connected )
{ $this->connect(); }
$mix_out = ftp_chmod( $this->resID, $str_mod, $str_path );
if ( $disconnect )
{ $this->disconnect(); }
return $mix_out;
}
/**
* Renames/moves a given file/directory.
*
* @access public
* @version 1.2
* @since 0.1.0
*
* @param string $oldname
* @param string $newname
* @param boolean $disconnect
*
* @return boolean
*/
function rename( $oldname, $newname, $disconnect = true )
{
if ( !$this->is_connected )
$this->connect();
if ( $this->is_connected )
{
$bool_tmp = ftp_rename( $this->resID, $oldname, $newname );
if ( $disconnect )
$this->disconnect();
return $bool_tmp;
}
return false;
}
/**
* To dissolve a directory means that all containing files will be shifted up
* a level and the directory itself will be removed.
* Beware: It does not function if there are files with the same name in the
* directory which has to be dissolve and the directory one level up.
*
* @access public
* @version 1.0
* @since 0.2.0
*
* @param string $str_dir
*
* @return boolean
*/
function dissolveDir( $str_dir )
{
if ( !$this->is_connected )
$this->connect();
$bool_no_err = false;
if ( $this->is_connected )
{
$str_dir = FilesystemToolkit::getCleanPath( $str_dir );
$str_to_dir_arr = FilesystemToolkit::separatePathAndFile( $str_dir );
$str_to_dir = FilesystemToolkit::getCleanPath( $str_to_dir_arr[0] );
$bool_no_err = true;
$file_arr = $this->loadFolderContent(
$str_dir, "", "", false, "name", false
);
foreach ( $file_arr as $str_file )
if ( !$bool_no_err )
{
$this->disconnect();
return false;
}
else
{
$bool_no_err = !$this->file_exists(
$str_to_dir."/".$str_file["name"], false
);
if ( $bool_no_err )
$bool_no_err = $this->rename(
$str_dir."/".$str_file["name"],
$str_to_dir."/".$str_file["name"],
false
);
}
if ( $bool_no_err )
$bool_no_err = ftp_rmdir( $this->resID, $str_dir );
$this->disconnect();
}
return $bool_no_err;
}
/**
* Copys a given file/directory.
*
* @access public
* @version 1.01
* @since 0.1.5
*
* @param string $fromname
* @param string $toname
* @param boolean $disconnect
*
* @return boolean
*/
function copy( $fromname, $toname, $disconnect = true )
{
if ( !$this->is_connected )
$this->connect();
if ( $this->is_connected )
{
$tmp_file = tmpfile();
$bool_tmp = ftp_fget( $this->resID, $tmp_file, $fromname, FTP_BINARY );
fseek( $tmp_file, 0 );
$bool_tmp = $bool_tmp
&& ftp_fput( $this->resID, $toname, $tmp_file, FTP_BINARY );
fclose( $tmp_file );
if ( $disconnect )
$this->disconnect();
return $bool_tmp;
}
return false;
}
/**
* Checks whether the given file exists.
*
* @access public
* @version 1.0
* @since 0.1.6
*
* @param string $filename
* @param boolean $disconnect
*
* @return boolean
*/
function file_exists( $filename, $disconnect = true )
{
if ( $this->is_dir( $filename, $disconnect ) )
return true;
else
{
$tmp_arr = FilesystemToolkit::separatePathAndFile( $filename );
$upper_dir = $tmp_arr[0];
$dir_cont_arr = $this->loadFolderContent(
$upper_dir, "", "", false, "name", $disconnect
);
foreach ( $dir_cont_arr as $value )
if ( $value["name"] == $tmp_arr[1] )
return true;
}
return false;
}
/**
* Checks whether the given file exists.
*
* @access public
* @version 1.0
* @since 0.1.6
*
* @param string $filename
* @param boolean $disconnect
*
* @return boolean
*/
function is_file( $filename, $disconnect = true )
{
if ( $this->is_dir( $filename, $disconnect ) )
return false;
else
{
$tmp_arr = FilesystemToolkit::separatePathAndFile( $filename );
$upper_dir = $tmp_arr[0];
$dir_cont_arr = $this->loadFolderContent(
$upper_dir, "", "", false, "name", $disconnect
);
foreach ( $dir_cont_arr as $value )
if ( $value["name"] == $tmp_arr[1] )
return true;
}
return false;
}
/**
* Checks whether the given directory exists.
*
* @access public
* @version 1.0
* @since 0.1.6
*
* @param string $dirname
* @param boolean $disconnect
*
* @return boolean
*/
function is_dir( $dirname, $disconnect = true )
{
if( !$this->is_connected )
$this->connect();
if( $this->is_connected )
{
# remember the current directory
$mem = ftp_pwd( $this->resID );
$out_bool = @ftp_chdir( $this->resID, $dirname );
# change to root directory
while (
@ftp_cdup( $this->resID )
&& ftp_pwd( $this->resID )
&& ftp_pwd( $this->resID ) != "/"
)
@ftp_cdup( $this->resID );
# change in the right current directory
if ( $mem )
@ftp_chdir( $this->resID, $mem );
clearstatcache();
if ( $disconnect )
$this->disconnect();
return $out_bool;
}
return false;
}
/**
* Creates a directory with given name.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $dirname
*
* @return boolean
*/
function mkdir( $dirname )
{
if( !$this->is_connected )
$this->connect();
if( $this->is_connected )
return ftp_mkdir( $this->resID, $dirname );
return false;
}
/**
* Creates a file with given name and content.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $file_path
* @param string $content
*
* @return boolean
*/
function saveFile( $file_path, $content )
{
if( !$this->is_connected )
$this->connect();
$f = new Files();
$f->setContent( $content );
$f->saveTmp();
if( $this->is_connected )
{
$out = ftp_fput( $this->resID, $file_path, $f->tmp_fh, FTP_BINARY );
# free memory
$f->deleteTmp();
unset( $f );
return $out;
}
$f->deleteTmp();
return false;
}
/**
* Puts out the size of a given file.
*
* @access public
* @version 1.0
* @since 0.1.7
*
* @param string $filename Where the file can be found.
* @param boolean $disconnect
*
* @return integer
*/
function filesize( $filename, $disconnect = true )
{
if ( !$this->is_connected )
$this->connect();
$out_int = ftp_size ( $this->resID, $filename );
if ( $disconnect )
$this->disconnect();
return $out_int;
}
/**
* Loads the content of a given file.
*
* @access public
* @version 1.0
* @since 0.1.7
*
* @param string $filename Where the file can be found.
* @param boolean $disconnect
* @return string
*/
function loadFileContent( $filename, $disconnect = true )
{
if ( !$this->is_connected )
$this->connect();
$f = tmpfile();
if ( $this->is_connected )
{
$bool_tmp = ftp_fget(
$this->resID,
$f,
$filename,
FTP_BINARY
);
if ( $disconnect )
$this->disconnect();
if ( $bool_tmp )
{
fseek( $f, 0 );
$out_str = fread( $f, $this->filesize( $filename, $disconnect ) );
fclose( $f );
clearstatcache();
return $out_str;
}
}
}
/**
* Reads out a remote folder.
*
* @access public
* @version 1.2
* @since 0.1.1
*
* @see http://www.php.net/manual/en/function.ftp-rawlist.php
*
* @author tig3r at poczta dot onet dot pl
* @author davidknoll at o2 dot co dot uk
* @author Daniel Plücken <daniel@debakel.net>
*
* @param string $dir
* @param string $regExpMatchFiles
* @param string $regExpMatchFolder
* @param boolean $filesize
* @param boolean $order_by
* @param boolean $disconnect
*
* @return boolean
*/
function loadFolderContent(
$dir,
$regExpMatchFiles = "",
$regExpMatchFolder = "",
$filesize = false,
$order_by = "name",
$disconnect = true
)
{
if( !$this->is_connected )
$this->connect();
$systype = ftp_systype( $this->resID );
$list = ftp_rawlist( $this->resID, "-a ".$dir );
$i = 0;
$parsed = array ();
switch( $systype )
{
case "Windows_NT":
if ( is_array( $list ) )
foreach( $list as $current )
{
$split = "";
ereg(
"([0-9]{2})-([0-9]{2})-([0-9]{2}) +([0-9]{2}):"
."([0-9]{2})(AM|PM) +([0-9]+|<DIR>) +(.+)",
$current, $split
);
if(
is_array( $split )
&& $split[8] != "."
&& $split[8] != ".."
&& (
$split[7] == "<DIR>"
&& (
empty( $regExpMatchFolder )
|| preg_match( $regExpMatchFolder, $split[8] )
)
|| $split[7] != "<DIR>"
&& (
empty( $regExpMatchFiles )
|| preg_match( $regExpMatchFiles, $split[8] )
)
)
)
{
if( $split[3] < 70 )
$split[3] += 2000;
else
$split[3] += 1900; // 4digit year fix
$parsed[$i]['is_dir'] = $split[7] == "<DIR>";
if( $filesize )
$parsed[$i]['size'] = $split[7];
$parsed[$i]['month'] = $split[1];
$parsed[$i]['day'] = $split[2];
$parsed[$i]['time/year'] = $split[3];
$parsed[$i]['name'] = $split[8];
$i++;
}
} // foreach
break;
case "UNIX":
default:
if ( is_array( $list ) )
foreach ( $list as $current )
{
$split = preg_split( "[ ]", $current, 9, PREG_SPLIT_NO_EMPTY );
if(
$split[0] != "total"
&& $split[8] != "."
&& $split[8] != ".."
&& (
$split[0]{0} === "d"
&& (
empty( $regExpMatchFolder )
|| preg_match( $regExpMatchFolder, $split[8] )
)
|| $split[0]{0} !== "d"
&& (
empty( $regExpMatchFiles )
|| preg_match( $regExpMatchFiles, $split[8] )
)
)
)
{
$parsed[$i]['is_dir'] = $split[0]{0} === "d";
$parsed[$i]['perms'] = $split[0];
$parsed[$i]['number'] = $split[1];
$parsed[$i]['owner'] = $split[2];
$parsed[$i]['group'] = $split[3];
if( $filesize )
$parsed[$i]['size'] = $split[4];
$parsed[$i]['month'] = $split[5];
$parsed[$i]['day'] = $split[6];
$parsed[$i]['time/year'] = $split[7];
$parsed[$i]['name'] = $split[8];
$i++;
}
} // foreach
break;
} // switch
if( count( $parsed ) > 1 )
Arrays::sortSecondDimension(
$parsed, $order_by,
is_bool( $parsed[0][$order_by] )
? "boolcmp_desc"
: "strcmp"
);
if( $disconnect )
$this->disconnect();
return $parsed;
}
/**
* Uploads a file.
*
* @access public
* @version 1.1
* @since 0.1.0
*
* @param string $local_file
* @param string $remote_file
*
* @return boolean
*/
function uploadFile( $local_file, $remote_file )
{
if ( !$this->is_connected )
$this->connect();
if ( $this->is_connected )
{
$bool_tmp = ftp_put(
$this->resID,
$remote_file,
$local_file,
FTP_BINARY
);
$this->disconnect();
return $bool_tmp;
}
return false;
}
/**
* Deletes a file or a folder. Folders will be delete recursively!
*
* @access public
* @version 1.01
* @since 0.1.4
*
* @param string $filename
* @param string $disconnect
*
* @return boolean
*/
function delete( $filename, $disconnect = true )
{
if( !$this->is_connected )
$this->connect();
if(
$this->is_connected
&& !empty( $filename )
&& !preg_match( "!^/+$!", $filename )
)
{
if( !@ftp_chdir( $this->resID, $filename ) )
# it is a file! -> delete it!
ftp_delete( $this->resID, $filename );
else
{
$tmp_arr = $this->loadFolderContent(
".", // current dir
$regExpMatchFiles = "",
$regExpMatchFolder = "",
$filesize = false,
$order_by = "name",
$disconnect = false
);
for( $i = 0; $i < count( $tmp_arr ); $i++ )
{
if( $tmp_arr[$i]["is_dir"] )
$this->delete( $tmp_arr[$i]["name"], false );
else
ftp_delete( $this->resID, $tmp_arr[$i]["name"] );
}
@ftp_cdup( $this->resID );
ftp_rmdir( $this->resID, basename( $filename ) );
}
}
if( $disconnect )
$this->disconnect();
}
/**
* Returns the hostname.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getHost()
{ return $this->name; }
/**
* Returns the hostname. This method is an alias of the method getHost().
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getName()
{ return $this->name; }
/**
* Returns the specified port to use to connect to the host.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return int
*/
function getPort()
{ return $this->port; }
/**
* Returns the specified user who should connect with to the host.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getUser()
{ return $this->user; }
/**
* Returns the given password which should be usedto connect to the host.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getPassword()
{ return $this->password; }
/**
* Stets the connection port. Standard is 21.
*
* @access public
* @version 1.0
* @since 0.1.9
*
* @param integer $int
*
* @return void
*/
function setPort( $int )
{
if ( preg_match( "!^\d+$!", $int ) )
{ $this->port = $int; }
}
/**
* Opens a connection to the ftp server.
*
* @access public
* @version 1.11
* @since 0.1.0
*
* @return boolean
*/
function connect()
{
if ( !($this->resID = ftp_connect( $this->name, $this->port )) )
{ return false; }
if ( !ftp_login( $this->resID, $this->user, $this->password ) )
{ return false; }
else
{
$this->is_connected = true;
return true;
}
}
/**
* Closes the current connection to the ftp server.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return void
*/
function disconnect()
{
if ( ftp_close( $this->resID ) )
{ $this->is_connected = false; }
}
} // END of class FTPHost
?>

Source for file FTPHost.class.php