Location: PHPKode > scripts > Filemanager > filemanager/class/FM_FileSystem.php
<?php

/**
 * This code is part of the FileManager software (www.gerd-tentler.de/tools/filemanager), copyright by
 * Gerd Tentler. Obtain permission before selling this code or hosting it on a commercial website or
 * redistributing it over the Internet or in any other medium. In all cases copyright must remain intact.
 */

include_once('FM_File.php');
include_once('FM_FileMp3.php');
include_once('FM_Tools.php');

/**
 * This class contains file system methods.
 *
 * @package FileManager
 * @subpackage class
 * @author Gerd Tentler
 */
class FM_FileSystem {

/* PUBLIC PROPERTIES *************************************************************************** */

	/**
	 * UNIX FTP listing row
	 *
	 * @var string
	 */
	var $unixRow = '/^([drwxst\-]{10}) +\d+ +([^ ]+) +([^ ]+) +(\d+) +(\w{3} +\d+ +(\d{2,4} )?[\d\:]{4,5}) +(.+)$/i';

	/**
	 * Windows FTP listing row
	 *
	 * @var string
	 */
	var $windowsRow = '/^([\d\.\-]+) +([\d\:]{5}[PA]?M?) +(<DIR>|[\d\.]+) +(.+)$/i';

/* PRIVATE PROPERTIES ************************************************************************** */

	/**
	 * holds FTP stream
	 *
	 * @var resource
	 */
	var $_ftp;

	/**
	 * FTP server
	 *
	 * @var string
	 */
	var $_host;

	/**
	 * FTP port number
	 *
	 * @var integer
	 */
	var $_port;

	/**
	 * OS type
	 *
	 * @var string
	 */
	var $_sysType;

	/**
	 * holds FileManager object
	 *
	 * @var FileManager
	 */
	var $_FileManager;

	/**
	 * holds Log object
	 *
	 * @var FM_Log
	 */
	var $_Log;

/* PUBLIC METHODS ****************************************************************************** */

	/**
	 * constructor
	 *
	 * @param FileManager $FileManager
	 * @return FM_FileSystem
	 */
	function FM_FileSystem(&$FileManager) {
		$this->_FileManager =& $FileManager;
		$this->_Log =& $this->_FileManager->Log;
	}

	/**
	 * connect to FTP server
	 *
	 * @param string $host			server
	 * @param integer $port			optional: port number
	 * @param integer $timeout		optional: timeout in seconds
	 * @return boolean
	 */
	function ftpConnect($host, $port = 21, $timeout = 30) {
		$this->_host = $host;
		$this->_port = $port;

		if($this->_FileManager->ftpSSL) {
			if(function_exists('ftp_ssl_connect')) {
				$this->_ftp = @ftp_ssl_connect($host, $port, $timeout);
			}
			else $this->_Log->add('No SFTP support on this server', 'error');
		}
		else $this->_ftp = @ftp_connect($host, $port, $timeout);

		if($this->_ftp) {
			@ftp_exec($this->_ftp, 'epsv4 off');
			$this->_Log->add("Connected to $host:$port");
			return true;
		}
		$this->_Log->add("Could not connect to $host:$port", 'error');
		return false;
	}

	/**
	 * close FTP connection
	 *
	 * @return boolean
	 */
	function ftpClose() {
		if(!$this->_ftp) return false;
		if(@ftp_quit($this->_ftp)) {
			$this->_Log->add("Closed connection to $this->_host:$this->_port");
			$this->_ftp = null;
			return true;
		}
		$this->_Log->add("Could not close connection to $this->_host:$this->_port", 'error');
		return false;
	}

	/**
	 * FTP login
	 *
	 * @param string $user			user name
	 * @param string $password		password
	 * @return boolean
	 */
	function ftpLogin($user, $password) {
		if(!$this->_ftp) return false;
		if(@ftp_login($this->_ftp, $user, $password)) {
			$this->_Log->add("User $user logged in");
			return true;
		}
		$this->_Log->add("User $user could not log in", 'error');
		return false;
	}

	/**
	 * switch to passive mode
	 *
	 * @param boolean $mode			true = passive, false = active
	 * @return boolean
	 */
	function ftpPassiveMode($mode) {
		if(!$this->_ftp) return false;
		if(@ftp_pasv($this->_ftp, $mode)) {
			if($mode) $this->_Log->add('Switched to passive mode');
			else $this->_Log->add('Switched to active mode');
			return true;
		}
		$this->_Log->add('Could not switch passive mode', 'error');
		return false;
	}

	/**
	 * get OS type
	 *
	 * @return string
	 */
	function getSystemType() {
		if($this->_sysType) return $this->_sysType;

		if($this->_checkFtp()) {
			$this->_sysType = @ftp_systype($this->_ftp);
		}
		else if(!$this->_FileManager->ftpHost) {
			$this->_sysType = function_exists('php_uname') ? php_uname() : PHP_OS;
		}

		if($this->_sysType) {
			if(!$this->_FileManager->hideSystemType) {
				$this->_Log->add("System type is $this->_sysType", 'info');
			}
			return $this->_sysType;
		}
		$this->_Log->add('Could not get system type', 'error');
		return false;
	}

	/**
	 * change directory
	 *
	 * @param string $path		directory path
	 * @return boolean
	 */
	function changeDir($path) {
		if($this->_checkFtp()) $ok = @ftp_chdir($this->_ftp, $path);
		else $ok = @chdir($path);
		$path = $this->_checkPath($path);

		if($ok) {
			$this->_Log->add("Changed directory to $path");
			return true;
		}
		$this->_Log->add("Could not change directory to $path", 'error');
		return false;
	}

	/**
	 * create directory
	 *
	 * @param string $dir		directory path
	 * @return boolean
	 */
	function makeDir($dir) {
		if($this->_checkFtp()) {
			$ok = @ftp_mkdir($this->_ftp, $dir);
			/* workaround for PHP bug */
			if(!$ok) $ok = @ftp_nlist($this->_ftp, $dir);
		}
		else $ok = @mkdir($dir, 0755);
		$dir = $this->_checkPath($dir);

		if($ok) {
			$this->_Log->add("Created directory $dir");
			return true;
		}
		$this->_Log->add("Could not create directory $dir", 'error');
		return false;
	}

	/**
	 * remove directory
	 *
	 * @param string $dir		directory path
	 * @return boolean
	 */
	function removeDir($dir) {
		if($this->_checkFtp()) $ok = @ftp_rmdir($this->_ftp, $dir);
		else $ok = @rmdir($dir);
		$dir = $this->_checkPath($dir);

		if($ok) {
			$this->_Log->add("Removed directory $dir");
			return true;
		}
		$this->_Log->add("Could not remove directory $dir - not empty?", 'error');
		return false;
	}

	/**
	 * read directory
	 *
	 * @param string $dir		directory path
	 * @param boolean $noLog	optional: don't generate log message
	 * @return array			entries
	 */
	function readDir($dir, $noLog = false) {
		if($this->_checkFtp()) {
			if($dir == '/' || $dir == '.') {
				$list = @ftp_rawlist($this->_ftp, $dir);
			}
			else if(($wd = @ftp_pwd($this->_ftp)) !== false) {
				if(@ftp_chdir($this->_ftp, $dir)) {
					$list = @ftp_rawlist($this->_ftp, '.');
					@ftp_chdir($this->_ftp, $wd);
				}
			}
			else $this->_Log->add('Could not get current work directory', 'error');
		}
		else if($dp = @opendir($dir)) {
			$list = array();
			while(($file = @readdir($dp)) !== false) {
				$list[] = $dir . '/' . $file;
			}
			@closedir($dp);
		}
		$dir = $this->_checkPath($dir);
		if(!$dir) $dir = '/';

		if(is_array($list)) {
			if(!$noLog) $this->_Log->add("Read directory $dir");
			return $list;
		}
		$this->_Log->add("Could not read directory $dir", 'error');
		return false;
	}

	/**
	 * change permissions
	 *
	 * @param string $path		file / directory name
	 * @param integer $mode		permissions
	 * @return boolean
	 */
	function changePerms($path, $mode) {
		$File = new FM_File($this->_FileManager, $path, $this->_checkFtp());
		$ok = $File->changePerms($mode);
		$path = $this->_checkPath($path);

		if($ok) {
			$this->_Log->add(sprintf('Changed permissions of %s to %o', $path, $mode));
			return true;
		}
		$this->_Log->add(sprintf('Could not change permissions of %s to %o', $path, $mode), 'error');
		return false;
	}

	/**
	 * get file from FTP server if necessary
	 *
	 * @param string $src			remote or local file path
	 * @param boolean $useFtpNb		optional: use FTP non-blocking mode
	 * @return mixed				local file path or array
	 */
	function getFile($src, $useFtpNb = false) {
		if($this->_checkFtp()) {
			$dstDir = $this->_FileManager->getCacheDir();
			$dst = $dstDir . '/' . md5($src);

			if(is_file($dst)) {
				return $dst;
			}
			else if($useFtpNb && function_exists('ftp_nb_get')) {
				$status = @ftp_nb_get($this->_ftp, $dst, $src, FTP_BINARY);
				if($status != FTP_FAILED) {
					$this->_Log->add('Got file ' . $this->_checkPath($src));
					return array($dst, $status, $this->_ftp);
				}
			}
			else if(@ftp_get($this->_ftp, $dst, $src, FTP_BINARY)) {
				$this->_Log->add('Got file ' . $this->_checkPath($src));
				return $dst;
			}
		}
		else if(is_file($src)) {
			return $src;
		}
		$src = $this->_checkPath($src);
		$this->_Log->add("Could not get file $src", 'error');
		return false;
	}

	/**
	 * upload file
	 *
	 * @param string $src		source path (local / temp)
	 * @param string $dst		destination path (remote / target dir)
	 * @return boolean
	 */
	function putFile($src, $dst) {
		$File = new FM_File($this->_FileManager, $src, $this->_checkFtp());
		$ok = $File->put($dst);
		$dst = $this->_checkPath($dst);

		if($ok) {
			$this->_Log->add("Saved file $dst");
			return true;
		}
		$this->_Log->add("Could not save file $dst", 'error');
		return false;
	}

	/**
	 * delete file
	 *
	 * @param string $path		file path
	 * @return boolean
	 */
	function deleteFile($path) {
		$restore = ($this->_FileManager->enableRestore && !preg_match('/\.' . FM_EXT_DELETED . '$/', $path));
		$File = new FM_File($this->_FileManager, $path, $this->_checkFtp());
		$ok = $File->delete($restore);
		$path = $this->_checkPath($path);

		if($restore) {
			if($ok) {
				$this->_Log->add("Moved file $path to recycle bin");
				return true;
			}
			$this->_Log->add("Could not move file $path to recycle bin", 'error');
			return false;
		}
		else {
			if($ok) {
				$this->_Log->add("Deleted file $path");
				return true;
			}
			$this->_Log->add("Could not delete file $path", 'error');
			return false;
		}
	}

	/**
	 * restore file
	 *
	 * @param string $path		file path
	 * @return boolean
	 */
	function restoreFile($path) {
		$File = new FM_File($this->_FileManager, $path, $this->_checkFtp());
		$ok = $File->restore();
		$path = $this->_checkPath(preg_replace('/\.' . FM_EXT_DELETED . '$/', '', $path));

		if($ok) {
			$this->_Log->add("Restored file $path");
			return true;
		}
		$this->_Log->add("Could not restore file $path", 'error');
		return false;
	}

	/**
	 * write file data
	 *
	 * @param string $path		file path
	 * @param string $data		file data
	 * @return boolean
	 */
	function writeFile($path, &$data) {
		if($data == '') return false;
		if(get_magic_quotes_gpc()) $data = stripslashes($data);
		$ok = false;

		if($this->_checkFtp()) {
			$srcPath = $this->_FileManager->getTmpDir() . '/' . FM_Tools::basename($path, $this->_FileManager->encoding);
			$ok = FM_Tools::saveLocalFile($srcPath, $data, $this->_FileManager->encoding);

			if($ok && is_file($srcPath)) {
				return $this->putFile($srcPath, $path);
			}
		}
		else $ok = FM_Tools::saveLocalFile($path, $data, $this->_FileManager->encoding);
		$path = $this->_checkPath($path);

		if($ok) {
			$this->_Log->add("Saved file $path");
			return true;
		}
		$this->_Log->add("Could not save file $path", 'error');
		return false;
	}

	/**
	 * copy file
	 *
	 * @param string $src		source path
	 * @param string $dst		destination path
	 * @return boolean
	 */
	function copyFile($src, $dst) {
		$File = new FM_File($this->_FileManager, $src, $this->_checkFtp());
		$ok = $File->copy($dst);
		$src = $this->_checkPath($src);
		$dst = $this->_checkPath($dst);

		if($ok) {
			$this->_Log->add("Copied $src => $dst");
			return true;
		}
		$this->_Log->add("Could not copy $src => $dst", 'error');
		return false;
	}

	/**
	 * rename file / directory
	 *
	 * @param string $src		source path
	 * @param string $dst		destination path
	 * @return boolean
	 */
	function rename($src, $dst) {
		$File = new FM_File($this->_FileManager, $src, $this->_checkFtp());
		$ok = $File->rename($dst);
		$src = $this->_checkPath($src);
		$dst = $this->_checkPath($dst);

		if($ok) {
			$this->_Log->add("Renamed $src => $dst");
			return true;
		}
		$this->_Log->add("Could not rename $src => $dst", 'error');
		return false;
	}

	/**
	 * read data from URL and save it to local file
	 *
	 * @param string $url		source URL
	 * @param string $dstDir	destination directory
	 * @return boolean
	 */
	function saveFromUrl($url, $dstDir) {
		$errno = $errstr = '';
		if(!strstr($url, '://')) $url = 'http://' . $url;
		$urlParts = @parse_url($url);
		$path = $urlParts['path'] . ($urlParts['query'] ? '?' . $urlParts['query'] : '');
		$path = str_replace(' ', '%20', $path);
		$port = $urlParts['port'] ? $urlParts['port'] : 80;
		$filename = FM_Tools::basename($urlParts['path'], $this->_FileManager->encoding);
		$dstPath = $dstDir . '/' . $filename;
		$ok = false;

		if($sp = @fsockopen($urlParts['host'], $port, $errno, $errstr, 15)) {
			fputs($sp, "GET $path HTTP/1.1\r\n");
			fputs($sp, "Host: {$urlParts['host']}\r\n");
			fputs($sp, "Connection: close\r\n\r\n");

			if($fp = @fopen($dstPath, 'wb')) {
				$buffer = '';
				$headerFound = false;
				$ok = true;

				while(!@feof($sp)) {
					$buffer .= @fread($sp, 4096);
					if(preg_match('/^HTTP\/[\d\.]+ (\d+) ([\w ]+)/i', $buffer, $m)) {
						if($m[1] != 200) {
							$errstr = "Host returned \"$m[1] $m[2]\"";
							$ok = false;
							break;
						}
					}

					if($headerFound) {
						@fwrite($fp, $buffer);
						$buffer = '';
					}
					else {
						$headerEnd = strpos($buffer, "\r\n\r\n");
						if($headerEnd !== false) {
							$headerFound = true;
							@fwrite($fp, substr($buffer, $headerEnd + 4));
							$buffer = '';
						}
					}
				}
				@fclose($fp);
				if($ok) $this->_Log->add("Got file $filename");
			}
			else $this->_Log->add("Could not open file $filename", 'error');
			@fclose($sp);
		}
		if($errstr) $this->_Log->add('Could not read data: ' . trim($errstr), 'error');
		return $ok;
	}

	/**
	 * read ID3 tags from MP3 file
	 *
	 * @param string $path		file path
	 * @return array
	 */
	function readId3Tags($path) {
		if($this->_FileManager->enableId3Tags) {
			if(preg_match('/\.mp3$/i', $path)) {
				if($path = $this->getFile($path)) {
					$File = new FM_FileMp3($this->_FileManager, $path, $this->_checkFtp());
					return $File->readId3Tags();
				}
			}
		}
		return false;
	}

/* PRIVATE METHODS ***************************************************************************** */

	/**
	 * check if FTP connection exists; create new one if necessary
	 *
	 * @return mixed
	 */
	function _checkFtp() {
		if($this->_FileManager->ftpHost && !$this->_ftp) {
			if($this->ftpConnect($this->_FileManager->ftpHost, $this->_FileManager->ftpPort)) {
				if($this->ftpLogin($this->_FileManager->ftpUser, $this->_FileManager->ftpPassword)) {
					$this->ftpPassiveMode($this->_FileManager->ftpPassiveMode);
				}
			}
		}
		return $this->_ftp;
	}

	/**
	 * remove start directory from file path
	 * remove additional extension from deleted files
	 *
	 * @param string $path		file path
	 * @return string
	 */
	function _checkPath($path) {
		$path = substr($path, strlen($this->_FileManager->startDir), strlen($path));
		if($this->_FileManager->enableRestore) $path = preg_replace('/\.' . FM_EXT_DELETED . '$/', '', $path);
		return $path;
	}
}

?>
Return current item: Filemanager