icy2003\php\icomponents\file\SftpFile

Complexity

Total Complexity

38

Size/Duplication

Total Lines	253
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	chown()	0	3	1
A	symlink()	0	3	1
A	_move()	0	3	1
A	_mkdir()	0	3	1
A	getFilesize()	0	3	1
A	putFileContent()	0	6	1
A	isDir()	0	3	1
A	chmod()	0	9	4
A	close()	0	3	1
A	getFileContent()	0	3	1
A	_rmdir()	0	3	1
A	createDir()	0	3	1
A	getRealpath()	0	3	1
A	uploadFile()	0	8	4
A	chgrp()	0	3	1
A	_copy()	0	3	1
A	downloadFile()	0	7	4
A	__getFilepath()	0	3	1
A	getCommandResult()	0	7	1
A	isFile()	0	3	1
A	__construct()	0	14	1
A	getLists()	0	16	6
A	deleteFile()	0	6	2

<?php
/**
 * Class SftpFile
 *
 * @link https://www.icy2003.com/
 * @author icy2003 <2317216477@qq.com>
 * @copyright Copyright (c) 2019, icy2003
 */
namespace icy2003\php\icomponents\file;

use icy2003\php\C;
use icy2003\php\I;
use icy2003\php\ihelpers\Arrays;

/**
 * sftp
 *
 * - 由于 PHP 里 sftp 提供的函数相对较少，为了让代码不那么诡异，这里用了很多 shell 命令
 * - Windows 平台自求多福
 */
class SftpFile extends Base
{
    /**
     * ssh 连接
     *
     * @var resource
     */
    protected $_conn;

    /**
     * sftp 对象
     *
     * @var resource
     */
    protected $_sftp;

    /**
     * 构造函数
     *
     * @param array $config sftp 连接配置。至少包括：host、username、password，可选：port、methods、callback
     */
    public function __construct($config)
    {
        C::assertFunction('ssh2_connect', '请开启 ssh2 扩展');
        C::assertTrue(Arrays::keyExistsAll(['host', 'username', 'password'], $config, $diff), '缺少 ' . implode(',', $diff) . ' 参数');
        $this->_conn = ssh2_connect(
            I::get($config, 'host'),

It seems like icy2003\php\I::get($config, 'host') can also be of type false; however, parameter $host of ssh2_connect() does only seem to accept string, maybe add an additional type check?

            I::get($config, 'port', 22),

It seems like icy2003\php\I::get($config, 'port', 22) can also be of type false and string; however, parameter $port of ssh2_connect() does only seem to accept integer, maybe add an additional type check?

            I::get($config, 'methods', []),

It seems like icy2003\php\I::get($config, 'methods', array()) can also be of type false and string; however, parameter $methods of ssh2_connect() does only seem to accept array|null, maybe add an additional type check?

            I::get($config, 'callback', [])

It seems like icy2003\php\I::get($config, 'callback', array()) can also be of type false and string; however, parameter $callbacks of ssh2_connect() does only seem to accept array|null, maybe add an additional type check?

        );
        C::assertNotFalse($this->_conn, '连接失败');
        C::assertNotFalse(ssh2_auth_password($this->_conn, I::get($config, 'username'), I::get($config, 'password')), '账号密码错误');

It seems like icy2003\php\I::get($config, 'password') can also be of type false; however, parameter $password of ssh2_auth_password() does only seem to accept string, maybe add an additional type check?

It seems like icy2003\php\I::get($config, 'username') can also be of type false; however, parameter $username of ssh2_auth_password() does only seem to accept string, maybe add an additional type check?

        $this->_sftp = ssh2_sftp($this->_conn);
        C::assertNotFalse($this->_sftp, '初始化 sftp 失败');
    }

    /**
     * @ignore
     */
    public function getCommandResult($command)
    {
        $stream = ssh2_exec($this->_conn, $command);
        stream_set_blocking($stream, true);
        $result = stream_get_contents($stream);
        fclose($stream);
        return $result;
    }

    /**
     * 获取 ssh2 协议格式的文件路径
     *
     * @param string $file 文件（目录）的路径
     *
     * @return string
     */
    private function __getFilepath($file)
    {
        return rtrim('ssh2.sftp://' . intval($this->_sftp), '/') . $file;
    }

    /**
     * @ignore
     */
    public function isFile($file)
    {
        return file_exists($this->__getFilepath($file));
    }

    /**
     * @ignore
     */
    public function isDir($dir)
    {
        return is_dir($this->__getFilepath($dir));
    }

    /**
     * @ignore
     */
    public function getRealpath($path)
    {
        return ssh2_sftp_realpath($this->_sftp, $path);
    }

    /**
     * @ignore
     */
    public function getLists($dir = null, $flags = FileConstants::COMPLETE_PATH)
    {
        $list = [];
        null === $dir && $dir = rtrim($this->getCommandResult('pwd'), PHP_EOL);
        $dir = rtrim($dir, '/') . '/';
        $command = 'ls -m "' . $dir . '"';
        $listString = rtrim($this->getCommandResult($command), PHP_EOL);
        $files = explode(', ', $listString);
        foreach ($files as $file) {
            $file = $this->getBasename($file);
            if (I::hasFlag($flags, FileConstants::RECURSIVE) && $this->isDir($dir . $file)) {
                $list = array_merge($list, $this->getLists($dir . $file, $flags));
            }
            $list[] = I::hasFlag($flags, FileConstants::COMPLETE_PATH) ? $dir . $file : $file;
        }
        return $list;
    }

    /**
     * @ignore
     */
    public function getFilesize($file)
    {
        return filesize($this->__getFilepath($file));
    }

    /**
     * @ignore
     */
    public function getFileContent($file)
    {
        return file_get_contents($this->__getFilepath($file));
    }

    /**
     * @ignore
     */
    public function putFileContent($file, $string, $mode = 0777)
    {
        $this->createDir($this->getDirname($file));
        $isCreated = false !== file_put_contents($this->__getFilepath($file), $string);
        $this->chmod($file, $mode, FileConstants::RECURSIVE_DISABLED);
        return $isCreated;
    }

    /**
     * @ignore
     */
    public function createDir($dir, $mode = 0777)
    {
        return ssh2_sftp_mkdir($this->_sftp, $dir, $mode, true);
    }

    /**
     * @ignore
     */
    public function deleteFile($file)
    {
        if ($this->isFile($file)) {
            return ssh2_sftp_unlink($this->_sftp, $file);
        }
        return true;
    }

    /**
     * @ignore
     */
    public function uploadFile($toFile, $fromFile = null, $overwrite = true)
    {
        null === $fromFile && $fromFile = './' . $this->getBasename($toFile);
        if (false === $overwrite && $this->isFile($toFile)) {
            return false;
        }
        $this->createDir($this->getDirname($toFile));
        return copy($fromFile, $this->__getFilepath($toFile));
    }

    /**
     * @ignore
     */
    public function downloadFile($fromFile, $toFile = null, $overwrite = true)
    {
        null === $toFile && $toFile = './' . $this->getBasename($fromFile);
        if (false === $overwrite && $this->isFile($toFile)) {
            return false;
        }
        return copy($this->__getFilepath($fromFile), $toFile);
    }

    /**
     * @ignore
     */
    public function chown($file, $user, $flags = FileConstants::RECURSIVE_DISABLED)
    {
        return false;
    }

    /**
     * @ignore
     */
    public function chgrp($file, $group, $flags = FileConstants::RECURSIVE_DISABLED)
    {
        return false;
    }

    /**
     * @ignore
     */
    public function chmod($file, $mode = 0777, $flags = FileConstants::RECURSIVE_DISABLED)
    {
        if ($this->isDir($file) && I::hasFlag($flags, FileConstants::RECURSIVE)) {
            $files = $this->getLists($file, FileConstants::COMPLETE_PATH | FileConstants::RECURSIVE);
            foreach ($files as $subFile) {
                @ssh2_sftp_chmod($this->_sftp, $subFile, $mode);

It seems like you do not handle an error condition for ssh2_sftp_chmod(). This can introduce security issues, and is generally not recommended.

            }
        }
        return @ssh2_sftp_chmod($this->_sftp, $subFile, $mode);

The variable $subFile does not seem to be defined for all execution paths leading up to this point.

    }

    /**
     * @ignore
     */
    public function symlink($from, $to)
    {
        return ssh2_sftp_symlink($this->_sftp, $from, $to);
    }

    /**
     * @ignore
     */
    public function close()
    {
        return ssh2_disconnect($this->_conn);
    }

    /**
     * @ignore
     */
    protected function _copy($fromFile, $toFile)
    {
        return copy($this->__getFilepath($fromFile), $this->__getFilepath($toFile));
    }

    /**
     * @ignore
     */
    protected function _move($fromFile, $toFile)
    {
        return ssh2_sftp_rename($this->_sftp, $fromFile, $toFile);
    }

    /**
     * @ignore
     */
    protected function _mkdir($dir, $mode = 0777)
    {
        return ssh2_sftp_mkdir($this->_sftp, $dir, $mode);
    }

    /**
     * @ignore
     */
    protected function _rmdir($dir)
    {
        return ssh2_sftp_rmdir($this->_sftp, $dir);
    }
}