LocalFile::__file() - Code Metrics - icy2003/php - Measure and Improve Code Quality continuously with Scrutinizer

LocalFile::__file() A
last analyzed 2024-05-09 17:43 UTC

↳ Parent: LocalFile
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	1
CRAP Score	1
Importance

Changes	2
Bugs	2	Features	0
Metric	Value
cc	1
eloc	1
c	2
b	2
f	0
nc	1
nop	1
dl	0
loc	3
rs	10
ccs	1
cts	1
cp	1
crap	1
<?php
/**
 * Class LocalFile
 *
 * @link https://www.icy2003.com/
 * @author icy2003 <[email protected]>
 * @copyright Copyright (c) 2019, icy2003
 */
namespace icy2003\php\icomponents\file;

use Exception;
use icy2003\php\C;
use icy2003\php\I;
use icy2003\php\icomponents\file\FileInterface;
use icy2003\php\ihelpers\Arrays;
use icy2003\php\ihelpers\Console;
use icy2003\php\ihelpers\Header;
use icy2003\php\ihelpers\Http;
use icy2003\php\ihelpers\Request;
use icy2003\php\ihelpers\Strings;

/**
 * 本地文件
 *
 * - 支持本地文件操作
 * - 支持网络文件部分属性：文件是否存在、文件大小
 */
class LocalFile extends Base implements FileInterface
{

    /**
     * 配置
     *
     * @var array
     */
    protected $_c = [
        'loader' => 'curl',
        'locale' => 'zh_CN.UTF-8',
        'buffer' => 4096,
        'mode' => 'rb',
        'rtrim' => true,
    ];

    /**
     * 文件属性
     *
     * - 文件名为键，属性为值
     *
     * @var array
     */
    protected $_attributes = [];

    /**
     * 初始化
     *
     * @param array $options 配置
     *      - locale：地区，默认 zh_CN.UTF-8
     *      - buffer：以字节方式读写时每段的字节长度，默认为 4096，即 4kb
     *      - mode：指定了所要求到该流的访问类型，默认 rb @link https://www.php.net/manual/zh/function.fopen.php
     *      - rtrim：在遍历行时是否去除行尾空白，默认 true，即去除
     *      - loader：读取远程资源时用的方法，默认为 curl（当其他方法无法读取时也会设置为 curl），支持值：curl、fopen、fsockopen
     *          - curl：使用 curl 获取远程文件信息
     *          - fopen：需要手动开启 allow_url_fopen 才能使用，不建议开启
     *          - fsockopen：使用 fsockopen 发送头获取信息
     * @return void
     */
    public function __construct($options = [])
    {
        $this->_c = Arrays::merge($this->_c, $options);
        setlocale(LC_ALL, (string) I::get($this->_c, 'locale', 'zh_CN.UTF-8'));
        clearstatcache();
    }

    /**
     * 获取 Hash 值
     *
     * @param string $fileName
     *
     * @return string
     */
    private function __hash($fileName)
    {
        return md5($fileName);
    }

    /**
     * 以别名返回路径
     *
     * @param string $file
     *
     * @return string
     */
    private function __file($file)
    {
        return (string) I::getAlias($file);
    }

    /**
     * 加载一个文件，本地（支持别名）或网络文件
     *
     * @param string $fileName
     *
     * @return static
     */
    protected function _load($fileName)
    {
        $fileName = $this->getRealpath($fileName);
        $hashName = $this->__hash($fileName);
        $this->_attributes[$hashName] = I::get($this->_attributes, $hashName, [
            'file' => $fileName,
            'isCached' => false,
            'isLocal' => true,
            // 以下属性需要重新设置
            'isExists' => false,
            'fileSize' => 0,
            'spl' => null,
            'splInfo' => null,
        ]);
        null === $this->_attributes[$hashName]['splInfo'] && $this->_attributes[$hashName]['splInfo'] = new \SplFileInfo($fileName);
        try {
            $splInfo = $this->_attributes[$hashName]['splInfo'];
            if (true !== $splInfo->isDir()) {
                null === $this->_attributes[$hashName]['spl'] && $this->_attributes[$hashName]['spl'] = new \SplFileObject($fileName, $this->_c['mode']);
            }
        } catch (Exception $e) {
            // 报错了也得继续跑，如果跑完一次 spl 和 splInfo 属性还是 null，在调用它们的时候自然会报错
            $this->_c['error'] = $e->getMessage();
            // 尝试用 curl 获取
            $this->_c['loader'] = 'curl';
        }
        // 如果已经被缓存了，直接返回
        if (true === $this->_attributes[$hashName]['isCached']) {
            return $this;
        }
        // 加上缓存标记
        $this->_attributes[$hashName]['isCached'] = true;
        if (preg_match('/^https?:\/\//', $fileName)) {
            $this->_attributes[$hashName]['isLocal'] = false;
            // 加载网络文件
            if ('curl' === $this->_c['loader'] && extension_loaded('curl')) {
                $curl = curl_init($fileName);
                if (is_resource($curl)) {
                    curl_setopt($curl, CURLOPT_NOBODY, true);
                    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
                    curl_setopt($curl, CURLOPT_HEADER, true);
                    // 公用名(Common Name)一般来讲就是填写你将要申请SSL证书的域名 (domain)或子域名(sub domain)
                    // - 设置为 1 是检查服务器SSL证书中是否存在一个公用名(common name)
                    // - 设置成 2，会检查公用名是否存在，并且是否与提供的主机名匹配
                    // - 0 为不检查名称。 在生产环境中，这个值应该是 2（默认值）
                    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
                    // 禁止 cURL 验证对等证书（peer's certificate）。要验证的交换证书可以在 CURLOPT_CAINFO 选项中设置
                    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
                    $result = curl_exec($curl);
                    if ($result && $info = curl_getinfo($curl)) {
                        if (200 == $info['http_code']) {
                            $this->_attributes[$hashName]['isExists'] = true;
                            $this->_attributes[$hashName]['fileSize'] = (int) $info['download_content_length'];
                        }
                    }
                    curl_close($curl);
                }
                return $this;
            }
            if ('fsockopen' === $this->_c['loader']) {
                $url = parse_url($fileName);
                $host = $url['host'];
                $path = (string) I::get($url, 'path', '/');
                $port = (int) I::get($url, 'port', 80);
                $fp = fsockopen($host, $port);
                if (is_resource($fp)) {
                    fputs($fp, "GET {$path} HTTP/1.1\r\n");
                    fputs($fp, "Host: {$host}:{$port}\r\n");
                    fputs($fp, "Connection: Close\r\n\r\n");
                    while (!feof($fp)) {
                        $line = fgets($fp);
                        preg_match('/HTTP.*(\s\d{3}\s)/', $line, $arr) && $this->_attributes[$hashName]['isExists'] = true;
                        preg_match('/Content-Length:(.*)/si', $line, $arr) && $this->_attributes[$hashName]['fileSize'] = (int) trim($arr[1]);
                    }
                    fclose($fp);
                }
                return $this;
            }
            if ('fopen' === $this->_c['loader'] && (bool) ini_get('allow_url_fopen')) {
                $headArray = (array) get_headers($fileName, 1);
                if (preg_match('/200/', $headArray[0])) {
                    $this->_attributes[$hashName]['isExists'] = true;
                    $this->_attributes[$hashName]['fileSize'] = (int) $headArray['Content-Length'];
                }
                return $this;
            }
        } else {
            $this->_attributes[$hashName]['isLocal'] = true;
            $this->_attributes[$hashName]['isExists'] = file_exists($fileName);
            if ($this->_attributes[$hashName]['isExists']) {
                $this->_attributes[$hashName]['fileSize'] = filesize($fileName);
            }
            $this->chmod($fileName, 0777, FileConstants::RECURSIVE_DISABLED);
        }
        return $this;
    }

    /**
     * 获取文件的属性
     *
     * @param string $fileName
     * @param string $name
     *
     * @return mixed
     */
    public function attribute($fileName, $name)
    {
        $this->_load($fileName);
        return I::get($this->_attributes, $this->__hash($this->getRealpath($fileName)) . '.' . $name);
    }

    /**
     * 获取文件对象
     *
     * @param string $fileName
     * @param string $mode 读写的模式，默认 rb
     *
     * @return \SplFileObject|null
     * @throws Exception
     */
    public function spl($fileName, $mode = 'rb')
    {
        $this->_c['mode'] = $mode;
        $spl = $this->attribute($fileName, 'spl');
        C::assertTrue($spl instanceof \SplFileObject, '文件打开失败：' . $fileName);
        return $spl;

    }

    /**
     * 获取文件信息对象
     *
     * @param string $fileName
     *
     * @return \SplFileInfo
     */
    public function splInfo($fileName)
    {
        $splInfo = $this->attribute($fileName, 'splInfo');
        return $splInfo;

    }

    /**
     * 遍历行的生成器
     *
     * - 自动关闭后再次调用需要重新读取文件，不建议自动关闭
     *
     * @param string $fileName
     * @param boolean $autoClose 是否自动关闭文件，默认 false
     *
     * @return \Generator
     */
    public function linesGenerator($fileName, $autoClose = false)
    {
        try {
            $spl = $this->spl($fileName, 'r');
            while (false === $spl->eof() && ($line = $spl->fgets())) {
                true === $this->_c['rtrim'] && $line = rtrim($line);
                yield $line;
            }
        } finally {
            true === $autoClose && $this->close($fileName);
        }
    }

    /**
     * 返回文本的某行
     *
     * - 每取一行，文件指针会回到初始位置，如果需要大量的行，请直接使用 linesGenerator
     * - 自动关闭后再次调用需要重新读取文件，不建议自动关闭
     *
     * @param string $fileName
     * @param integer $lineNumber 行号
     * @param boolean $autoClose 是否自动关闭文件，默认 false
     *
     * @return string|null
     */
    public function line($fileName, $lineNumber = 0, $autoClose = false)
    {
        $spl = $this->spl($fileName, 'r');
        $lineNumber = (int) $lineNumber;
        foreach ($this->linesGenerator($fileName, $autoClose) as $k => $line) {
            if ($k === $lineNumber) {
                $spl->rewind();
                return $line;
            }
        }
        return null;
    }

    /**
     * 遍历字节的生成器
     *
     * - 自动关闭后再次调用需要重新读取文件，不建议自动关闭
     *
     * @param string $fileName
     * @param boolean $autoClose 是否自动关闭文件，默认 false
     * @param integer|null $buffer 每次读取的字节数，默认 null，值等于初始化时的 buffer 选项
     *
     * @return \Generator
     */
    public function dataGenerator($fileName, $autoClose = false, $buffer = null)
    {
        $bufferSize = 0;
        null === $buffer && $buffer = $this->_c['buffer'];
        try {
            $spl = $this->spl($fileName, 'rb');
            $size = $this->getFilesize($fileName);
            while (!$spl->eof() && $size > $bufferSize) {
                $bufferSize += $buffer;
                yield $spl->fread($bufferSize);
            }
        } finally {
            true === $autoClose && $this->close($fileName);
        }
    }

    /**
     * @ignore
     */
    public function getATime($fileName)
    {
        return fileatime($this->__file($fileName));
    }

    /**
     * @ignore
     */
    public function getBasename($file, $suffix = null)
    {
        return parent::getBasename($this->__file($file), $suffix);
    }

    /**
     * @ignore
     */
    public function getCTime($fileName)
    {
        return filectime($this->__file($fileName));
    }

    /**
     * @ignore
     */
    public function getExtension($fileName)
    {
        return pathinfo($this->__file($fileName), PATHINFO_EXTENSION);

    }

    /**
     * @ignore
     */
    public function getFilename($fileName)
    {
        return pathinfo($this->__file($fileName), PATHINFO_FILENAME);

    }

    /**
     * @ignore
     */
    public function getMtime($fileName)
    {
        return filemtime($this->__file($fileName));
    }

    /**
     * @ignore
     */
    public function getDirname($path)
    {
        return parent::getDirname($this->__file($path));
    }

    /**
     * @ignore
     */
    public function getPerms($path)
    {
        return fileperms($this->__file($path));
    }

    /**
     * @ignore
     */
    public function getFilesize($fileName)
    {
        return (int) $this->attribute($fileName, 'fileSize');
    }

    /**
     * @ignore
     */
    public function getType($path)
    {
        return filetype($this->__file($path));
    }

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

    /**
     * @ignore
     */
    public function isDot($dir)
    {
        return in_array($this->getBasename($dir), ['.', '..']);
    }

    /**
     * @ignore
     */
    public function isFile($file)
    {
        $isLocal = $this->attribute($file, 'isLocal');
        if (true === $isLocal) {
            return is_file($this->__file($file));
        } else {
            return (bool) $this->attribute($file, 'isExists');
        }
    }

    /**
     * @ignore
     */
    public function isLink($link)
    {
        return is_link($this->__file($link));
    }

    /**
     * @ignore
     */
    public function isReadable($path)
    {
        return is_readable($this->__file($path));
    }

    /**
     * @ignore
     */
    public function isWritable($path)
    {
        return is_writable($this->__file($path));
    }

    /**
     * @ignore
     */
    public function getCommandResult($command)
    {
        return Console::exec($command);
    }

    /**
     * @ignore
     */
    public function getRealpath($path)
    {
        $path = $this->__file($path);
        $realPath = realpath($path);
        false === $realPath && $realPath = parent::getRealpath($path);
        return Strings::replace($realPath, ["\\" => '/']);
    }

    /**
     * @ignore
     */
    public function getLists($dir = null, $flags = FileConstants::COMPLETE_PATH | FileConstants::RECURSIVE_DISABLED)
    {
        null === $dir && $dir = $this->getRealpath('./');
        $dir = rtrim($this->__file($dir), '/') . '/';
        $iterator = new \RecursiveDirectoryIterator($dir, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS);
        if (I::hasFlag($flags, FileConstants::RECURSIVE)) {
            $iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::CHILD_FIRST);
        }
        $files = [];
        /**
         * @var \RecursiveDirectoryIterator $file
         */
        foreach ($iterator as $file) {
            if (I::hasFlag($flags, FileConstants::COMPLETE_PATH)) {
                $files[] = $file->getPathname();
            } else {
                $files[] = $file->getFilename();
            }
        }
        return $files;
    }

    /**
     * @ignore
     */
    public function getFileContent($file)
    {
        if ($this->isFile($file)) {
            return file_get_contents($this->__file($file));
        }
        return false;
    }

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

    /**
     * @ignore
     */
    public function deleteFile($file)
    {
        if ($this->isFile($file)) {
            $this->close($file);
            return unlink($this->__file($file));
        }
        return true;
    }

    /**
     * @ignore
     */
    public function uploadFile($fileMap, $overwrite = true)
    {
        return false;
    }

    /**
     * 从远程下载文件到本地
     *
     * @ignore
     */
    public function downloadFile($fileMap, $overwrite = true)
    {
        set_time_limit(0);
        list($fromFile, $toFile) = $this->fileMap($fileMap);
        $this->createDir($this->getDirname($toFile));
        if ($this->isFile($toFile) && false === $overwrite) {
            return true;
        }
        $content = Http::get($fromFile);
        return $this->putFileContent($toFile, $content);
    }

    /**
     * download() 配置名：ip
     */
    const C_DOWNLOAD_IP = 'ip';
    /**
     * download() 配置名：speed
     */
    const C_DOWNLOAD_SPEED = 'speed';
    /**
     * download() 配置名：xSendFile
     */
    const C_DOWNLOAD_X_SEND_FILE = 'xSendFile';
    /**
     * download() 配置名：xSendFileRoot
     */
    const C_DOWNLOAD_X_SEND_FILE_ROOT = 'xSendFileRoot';

    /**
     * 服务端给客户端提供下载请求
     *
     * @param string|array $fileName self::fileMap()
     * @param null|array $config 配置项
     *      - ip：限特定 IP 访问，数组或逗号字符串，默认为 *，即对所有 IP 不限制
     *      - speed：限速，默认不限速（读取速度为1024 * [buffer]），单位 kb/s
     *      - xSendFile：是否使用 X-Sendfile 进行下载，默认 false，即不使用。X-Sendfile 缓解了 PHP 的压力，但同时 PHP 将失去对资源的控制权，因为 PHP 并不知道资源发完了没
     *      - xSendFileRoot：文件根路径，默认为 /protected/。此时 Nginx 可作如下配置，更多 @link https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/
     *      ```nginx.conf
     *      location /protected/ {
     *          internal; # 表示这个路径只能在 Nginx 内部访问，不能用浏览器直接访问防止未授权的下载
     *          alias   /usr/share/nginx/html/protected/; # 别名
     *          # root    /usr/share/nginx/html; # 根目录
     *      }
     *      ```
     * @param callback $callback 下载完成后的回调，参数列表：文件属性数组
     *
     * @return void
     * @info 此函数之后不得有任何输出
     * @throws Exception
     */
    public function download($fileName, $config = null, $callback = null)
    {
        Header::xPoweredBy();
        set_time_limit(0);
        list($originName, $downloadName) = $this->fileMap($fileName);
        $originName = $this->__file($originName);
        try {
            $ip = (string) I::get($config, self::C_DOWNLOAD_IP, '*');
            if ('*' !== $ip) {
                C::assertTrue(Arrays::in((new Request())->getUserIP(), Strings::toArray($ip)), 'http/1.1 403.6 此 IP 禁止访问');
            }
            if ($this->isFile($originName)) {
                $fileSize = $this->getFilesize($originName);
                header('Content-type:application/octet-stream');
                header('Accept-Ranges:bytes');
                header('Content-Length:' . $fileSize);
                header('Content-Disposition: attachment; filename=' . $downloadName);
                $speed = (int) I::get($config, self::C_DOWNLOAD_SPEED, 0);
                $xSendFile = I::get($config, self::C_DOWNLOAD_X_SEND_FILE, false);
                $xSendFileRoot = (string) I::get($config, self::C_DOWNLOAD_X_SEND_FILE_ROOT, '/protected/');
                if (true === $xSendFile) {
                    $path = rtrim($xSendFileRoot, '/') . '/' . $this->getBasename($originName);
                    header('X-Accel-Redirect: ' . $path); // Nginx、Cherokee 实现了该头
                    header('X-Sendfile: ' . $path); // Apache、Lighttpd v1.5、Cherokee 实现了该头
                    header('X-LIGHTTPD-send-file: ' . $path); // Lighttpd v1.4 实现了该头
                    if ($speed) {
                        header('X-Accel-Limit-Rate: ' . $speed); // 单位 kb/s
                    }
                } else {
                    flush();
                    foreach ($this->dataGenerator($originName, true, ($speed ? $speed : $this->_c['buffer'] * 1024)) as $data) {
                        echo $data;
                        flush();
                        $speed > 0 && sleep(1);
                    }
                }
            }
        } catch (Exception $e) {
            header($e->getMessage());
        } finally {
            I::call($callback, [$this->_attributes]);
            // 必须要终止掉，防止发送其他数据导致错误
            die;

        }
    }

    /**
     * @ignore
     */
    public function chown($file, $user, $flags = FileConstants::RECURSIVE_DISABLED)
    {
        $file = $this->__file($file);
        if ($this->isDir($file) && I::hasFlag($flags, FileConstants::RECURSIVE)) {
            $files = $this->getLists($file, FileConstants::COMPLETE_PATH | FileConstants::RECURSIVE);
            foreach ($files as $subFile) {
                /** @scrutinizer ignore-unhandled */@chown($subFile, $user);
            }
        } elseif ($this->isFile($file)) {
            return /** @scrutinizer ignore-unhandled */@chown($file, $user);
        } else {
            return false;
        }
    }

    /**
     * @ignore
     */
    public function chgrp($file, $group, $flags = FileConstants::RECURSIVE_DISABLED)
    {
        $file = $this->__file($file);
        if ($this->isDir($file) && I::hasFlag($flags, FileConstants::RECURSIVE)) {
            $files = $this->getLists($file, FileConstants::COMPLETE_PATH | FileConstants::RECURSIVE);
            foreach ($files as $subFile) {
                /** @scrutinizer ignore-unhandled */@chgrp($subFile, $group);
            }
        } elseif ($this->isFile($file)) {
            return /** @scrutinizer ignore-unhandled */@chgrp($file, $group);
        } else {
            return false;
        }
    }

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

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

    /**
     * @ignore
     */
    public function close($fileName = null)
    {
        if (is_string($fileName)) {
            $fileName = [$this->__hash($this->getRealpath($fileName))];
        } elseif (is_array($fileName)) {
            foreach ($fileName as $k => $name) {
                $fileName[$k] = $this->__hash($this->getRealpath($name));
            }
        }
        foreach ($this->_attributes as $hashName => /** @scrutinizer ignore-unused */$attribute) {
            if (null === $fileName || is_array($fileName) && in_array($hashName, $fileName)) {
                unset($this->_attributes[$hashName]);
            }
        }
        return true;
    }

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

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

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

    /**
     * @ignore
     */
    protected function _rmdir($dir)
    {
        $dir = $this->__file($dir);
        return rmdir($dir);
    }

}

icy2003 / php

GitHub Access Token became invalid

LocalFile::__file() A last analyzed 2024-05-09 17:43 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

LocalFile::__file() A
last analyzed 2024-05-09 17:43 UTC
