WindSocketFtp.php

<?php
Wind::import("WIND:ftp.AbstractWindFtp");
/**
 * 采用sockey方式实现ftp操作
 * 
 * 使用方法和普通类库一样:
 * <code>
 * Wind::import('WIND:ftp.WindSocketFtp');
 * $ftp = new WindSocketFtp(array('server' => '192.168.1.10', 'port' => '21', ‘user' => 'test', 'pwd' => '123456'));
 * print_r($ftp->fileList());
 * </code>
 *
 * @author xiaoxia.xu <xiaoxia.xuxx@aliyun-inc.com>
 * @copyright ©2003-2103 phpwind.com
 * @license http://www.windframework.com
 * @version $Id: WindSocketFtp.php 3904 2013-01-08 07:01:26Z yishuo $
 * @package ftp
 */
class WindSocketFtp extends AbstractWindFtp {
	/**
	 * 临时链接对象保存
	 *
	 * @var object
	 */
	private $tmpConnection;
	
	/**
	 * 构造函数
	 * 
	 * 通过传入config构造链接对象
	 * 
	 * @param array $config ftp配置文件
	 */
	public function __construct($config = array()) {
		$this->getConnection($config);
	}
	
	/**
	 * 获得ftp链接
	 * 
	 * @param array $config ftp的配置信息：
	 * <ul>
	 * <li>server: ftp主机地址</li>
	 * <li>port: ftp链接端口号，默认为21</li>
	 * <li>user: ftp链接用户名</li>
	 * <li>pwd: ftp链接用户密码</li>
	 * <li>dir: ftp链接后切换的目录,默认为空</li>
	 * <li>timeout: ftp链接超时时间,默认为10秒</li>
	 * </ul>
	 * @return boolean 
	 */
	private function getConnection($config) {
		$this->initConfig($config);
		$errno = 0;
		$errstr = '';
		$this->conn = fsockopen($this->server, $this->port, $errno, $errstr, $this->timeout);
		if (!$this->conn || !$this->checkcmd()) {
			throw new WindFtpException("[ftp.WindSocketFtp.getConnection] $this->server:$this->port\r\nEroor:$errstr ($errno)!", WindFtpException::CONNECT_FAILED);
		}
		stream_set_timeout($this->conn, $this->timeout);
		
		if (!$this->sendcmd('USER', $this->user)) {
			throw new WindFtpException('[ftp.WindSocketFtp.getConnection] ' . $this->user, WindFtpException::LOGIN_FAILED);
		}
		if (!$this->sendcmd('PASS', $this->pwd)) {
			throw new WindFtpException('[ftp.WindSocketFtp.getConnection] error password for ' . $this->user, WindFtpException::LOGIN_FAILED);
		}
		
		$this->initRootPath();
		return true;
	}

	/* (non-PHPdoc)
	 * @see AbstractWindFtp::pwd()
	 */
	protected function pwd() {
		$this->sendcmd('PWD', '', false);
		if (!($path = $this->checkcmd(true)) || !preg_match("/^[0-9]{3} \"(.+?)\"/", $path, $matchs)) {
			return '/';
		}
		return $matchs[1] . ((substr($matchs[1], -1) == '/') ? '' : '/');
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::upload()
	 */
	public function upload($localfile, $remotefile, $mode = 'I') {
		if (!in_array(($savedir = dirname($remotefile)), array('.', '/'))) {
			$this->mkdirs($savedir);
		}
		$remotefile = $this->rootPath . WindSecurity::escapePath($remotefile);
		if (!($fp = fopen($localfile, 'rb'))) {
			throw new WindFtpException('[ftp.WindSocketFtp.upload] ' . $localfile, WindFtpException::FILE_READ_FOBIDDEN);
		}
		$mode != 'I' && $mode = 'A';
		$this->delete($remotefile);
		if (!$this->sendcmd('TYPE', $mode)) {
			throw new WindFtpException('[ftp.WindSocketFtp.upload] ' . $mode, WindFtpException::COMMUNICATE_TYPE_FAILED);
		}
		$this->openTmpConnection();
		$this->sendcmd('STOR', $remotefile);
		while (!feof($fp)) {
			fwrite($this->tmpConnection, fread($fp, 4096));
		}
		fclose($fp);
		$this->closeTmpConnection();

		if (!$this->checkcmd()) {
			throw new WindFtpException('[ftp.WindSocketFtp.upload] PUT', WindFtpException::COMMAND_FAILED);
		} else {
			$this->sendcmd('SITE CHMOD', base_convert(0644, 10, 8) . " $remotefile");
		}
		return $this->size($remotefile);
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::download()
	 */
	public function download($localfile, $remotefile = '', $mode = 'I') {
		$mode != 'I' && $mode = 'A';
		if (!$this->sendcmd('TYPE', $mode)) {
			throw new WindFtpException('[ftp.WindSocketFtp.download] ' . $mode, WindFtpException::COMMUNICATE_TYPE_FAILED);
		}
		$this->openTmpConnection();
		if (!$this->sendcmd('RETR', $remotefile)) {
			$this->closeTmpConnection();
			return false;
		}
		if (!($fp = fopen($localfile, 'wb'))) {
			throw new WindFtpException('[ftp.WindSocketFtp.download] ' . $localfile, WindFtpException::FILE_READ_FOBIDDEN);
		}
		while (!feof($this->tmpConnection)) {
			fwrite($fp, fread($this->tmpConnection, 4096));
		}
		fclose($fp);
		$this->closeTmpConnection();

		if (!$this->checkcmd()) throw new WindFtpException('[ftp.WindSocketFtp.download] GET', WindFtpException::COMMAND_FAILED);
		return true;
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::size()
	 */
	public function size($file) {
		$this->sendcmd('SIZE', $file, false);
		if (!($size_port = $this->checkcmd(true))) {
			throw new WindFtpException('[ftp.WindSocketFtp.size] SIZE', WindFtpException::COMMAND_FAILED);
		}
		return preg_replace("/^[0-9]{3} ([0-9]+)\r\n/", "\\1", $size_port);
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::delete()
	 */
	public function delete($file) {
		return $this->sendcmd('DELE', $this->rootPath . WindSecurity::escapePath($file));
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::rename()
	 */
	public function rename($oldname, $newname) {
		if (!in_array(($savedir = dirname($newname)), array('.', '/'))) {
			$this->mkdirs($savedir);
		}
		$oldname = $this->rootPath . WindSecurity::escapeDir($oldname);
		$this->sendcmd('RNFR', $oldname);
		return $this->sendcmd('RNTO', $newname);
	}

	/* (non-PHPdoc)
	 * @see AbstractWindFtp::mkdir()
	 */
	public function mkdir($dir) {
		$base777 = base_convert(0777, 10, 8);
		$result = $this->sendcmd('MKD', $dir);
		return $this->sendcmd('SITE CHMOD', "$base777 $dir");
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::changeDir()
	 */
	public function changeDir($dir) {
		$dir = (($dir[0] != '/') ? '/' : '') . $dir;
		if ($dir !== '/' && substr($dir, -1) == '/') {
			$dir = substr($dir, 0, -1);
		}
		if (!$this->sendcmd('CWD', $dir)) {
			throw new WindFtpException('[ftp.WindSocketFtp.changeDir] ' . $dir, WindFtpException::COMMAND_FAILED_CWD);
		}
		return true;
	}

	/* (non-PHPdoc)
	 * @see AbstractWindFtp::fileList()
	 */
	public function fileList($dir = '') {
		$this->openTmpConnection();
		$this->sendcmd('NLST', $dir);
		$list = array();
		while (!feof($this->tmpConnection)) {
			$list[] = preg_replace('/[\r\n]/', '', fgets($this->tmpConnection, 512));
		}
		$this->closeTmpConnection();
		if (!$this->checkcmd(true)) throw new WindFtpException('[ftp.WindSocketFtp.fileList] LIST', WindFtpException::COMMAND_FAILED);
		return $list;
	}
	
	/* (non-PHPdoc)
	 * @see AbstractWindFtp::close()
	 */
	public function close() {
		if (!$this->conn) return false;
		if (!$this->sendcmd('QUIT') || !fclose($this->conn)) throw new WindFtpException('[ftp.WindSocketFtp.fileList] QUIT', WindFtpException::COMMAND_FAILED);
		return true;
	}

	/**
	 * 发送ftp处理命令
	 * 
	 * @param string $cmd 待发送的命令
	 * @param string $args 命令参数
	 * @param boolean $check 是否需要检查返回状态,默认为true需要检查
	 * @return boolean 如果检查命令发送失败则返回false,否则返回true
	 */
	private function sendcmd($cmd, $args = '', $check = true) {
		!empty($args) && $cmd .= " $args";
		fputs($this->conn, "$cmd\r\n");
		if ($check === true && !$this->checkcmd()) return false;
		return true;
	}
	
	/**
	 * 检查命令状态
	 * 
	 * @param boolean $return 是否需要返回命令状态信息,默认为false,不许要返回
	 * @return boolean|string 检查命令已经发送成功，则返回true,失败则返回false,如果设置了参数$return=true并且命令状态正确的情况下将会返回状态信息
	 */
	private function checkcmd($return = false) {
		$resp = $rcmd = '';
		$i = 0;
		do {
			$rcmd = fgets($this->conn, 512);
			$resp .= $rcmd;
		} while (++$i < 20 && !preg_match('/^\d{3}\s/is', $rcmd));

		if (!preg_match('/^[123]/', $rcmd)) return false;
		return $return ? $resp : true;
	}

	/**
	 * 打开临时链接句柄
	 * 
	 * @return boolean 如果打开成功返回true
	 */
	private function openTmpConnection() {
		$this->sendcmd('PASV', '', false);
		if (!($ip_port = $this->checkcmd(true))) {
			throw new WindFtpException('[ftp.WindSocketFtp.openTmpConnection] PASV', WindFtpException::COMMAND_FAILED);
		}
		if (!preg_match('/[0-9]{1,3},[0-9]{1,3},[0-9]{1,3},[0-9]{1,3},[0-9]+,[0-9]+/', $ip_port, $temp)) {
			throw new WindFtpException('[ftp.WindSocketFtp.openTmpConnection] ' . $ip_port, WindFtpException::COMMAND_FAILED_PASS_PORT);
		}
		$temp = explode(',', $temp[0]);
		$server_ip = "$temp[0].$temp[1].$temp[2].$temp[3]";
		$server_port = $temp[4] * 256 + $temp[5];
		if (!$this->tmpConnection = fsockopen($server_ip, $server_port, $errno, $errstr, $this->timeout)) {
			throw new WindFtpException("[ftp.WindSocketFtp.openTmpConnection] {$server_ip}:{$server_port}\r\nError:{$errstr} ({$errno})", WindFtpException::OPEN_DATA_CONNECTION_FAILED);
		}
		stream_set_timeout($this->tmpConnection, $this->timeout);
		return true;
	}
	
	/**
	 * 关闭临时链接对象
	 * 
	 * @return boolean 关闭成功返回true,失败返回false
	 */
	private function closeTmpConnection() {
		return fclose($this->tmpConnection);
	}
}
?>