majiameng / uploads

src/Gateways/Oss.php

<?php

// +----------------------------------------------------------------------
// | date: 2015-09-09
// +----------------------------------------------------------------------
// | OssAdapter.php: oss上传
// +----------------------------------------------------------------------
// | Author: Tinymeng <666@majiameng.com>
// +----------------------------------------------------------------------


namespace tinymeng\uploads\Gateways;

use Exception;
use OSS\OssClient;
use OSS\Core\OssException;
use tinymeng\uploads\exception\TinymengException;
use tinymeng\uploads\Connector\Gateway;
use tinymeng\uploads\Helper\PathLibrary;
use tinymeng\uploads\Helper\FileFunction;

class Oss extends  Gateway
{

    const FILE_TYPE_FILE    = 'file';//类型是文件
    const FILE_TYPE_DIR     = 'dir';//类型是文件夹


    /**
     * oss client 上传对象
     *
     * @var OssClient
     */
    protected $upload;

    /**
     * bucket
     *
     * @var string
     */
    protected $bucket;

    /**
     * 构造方法
     *
     * @param array $config   配置信息
     * @author Tinymeng <666@majiameng.com>
     */
    public function __construct($config)
    {
        $baseConfig = [
            'accessKeyId'		=> '',
            'accessKeySecret' 	=> '',
            'endpoint'			=> '',
            'isCName'			=> false,
            'securityToken'		=> null,
            'bucket'            => '',
            'timeout'           => '5184000',
            'connectTimeout'    => '10',
            'transport'     	=> 'http',//如果支持https，请填写https，如果不支持请填写http
            'max_keys'          => 1000,//max-keys用于限定此次返回object的最大数，如果不设定，默认为100，max-keys取值不能大于1000
        ];
        $this->config   = array_replace_recursive($baseConfig,$config);
        $this->bucket   = $this->config['bucket'];
        //设置路径前缀
        $this->setPathPrefix($this->config['transport'] . '://' . $this->config['bucket'] . '.' .  $this->config['endpoint']);
    }

    /**
     * 格式化路径
     *
     * @param $path
     * @return string
     */
    protected static function normalizerPath($path, $is_dir = false)
    {
        $path = ltrim(PathLibrary::normalizerPath($path, $is_dir), '/');

        return $path == '/' ? '' : $path;
    }

    /**
     * 获得OSS client上传对象
     *
     * @return \OSS\OssClient
     * @author Tinymeng <666@majiameng.com>
     */
    protected function getClient()
    {
        if (!$this->client) {
            $this->client = new OssClient(
                $this->config['accessKeyId'],
                $this->config['accessKeySecret'],
                $this->config['endpoint'],
                $this->config['isCName'],
                $this->config['securityToken']
            );

            //设置请求超时时间
            $this->client->setTimeout($this->config['timeout']);

            //设置连接超时时间
            $this->client->setConnectTimeout($this->config['connectTimeout']);
        }

        return $this->client;
    }

    /**
     * 获得 Oss 实例
     * @return OssClient
     */
    public function getInstance()
    {
        return $this->getClient();
    }

    /**
     * 判断文件是否存在
     * @param string $path
     * @return bool
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function has($path)
    {
        try {
            return $this->getClient()->doesObjectExist($this->bucket, $path) != false ? true : false;
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 读取文件
     * @param $path
     * @return array
     * @throws TinymengException
     * @internal param $file_name
     * @author Tinymeng <666@majiameng.com>
     */
    public function read($path)
    {
        try {
            return ['contents' => $this->getClient()->getObject($this->bucket, static::normalizerPath($path)) ];
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 获得文件流
     * @param string $path
     * @return array|bool
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function readStream($path)
    {
        try {
            //获得一个临时文件
            $tmpfname       = FileFunction::getTmpFile();

            file_put_contents($tmpfname, $this->read($path)['contents'] );

            $handle         = fopen($tmpfname, 'r');

            //删除临时文件
            FileFunction::deleteTmpFile($tmpfname);

            return ['stream' => $handle];
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 写入文件
     *
     * @param $path
     * @param $contents
     * @param array $option
     * @return mixed
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function write($path, $contents,$option=[])
    {
        try {
            $path = static::normalizerPath($path);
            return $this->getClient()->putObject($this->bucket, $path, $contents, $option);
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 写入文件流
     * @param string $path
     * @param resource $resource
     * @param array $option
     * @return array|bool|false
     * @throws TinymengException
     */
    public function writeStream($path, $resource, $option=[])
    {
        try{
            $path = static::normalizerPath($path);
            //获得一个临时文件
            $tmpfname = FileFunction::getTmpFile();

            // 将资源流写入临时文件
            $contents = stream_get_contents($resource);
            file_put_contents($tmpfname, $contents);

            $this->getClient()->uploadFile($this->bucket, $path, $tmpfname, $option);

            //删除临时文件
            FileFunction::deleteTmpFile($tmpfname);
            return true;

The expression return true returns the type true which is incompatible with the return type mandated by tinymeng\uploads\Connector\GatewayInterface::writeStream() of array|false.

        } catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * Name: 上传文件
     * Author: Tinymeng <666@majiameng.com>
     * @param $path
     * @param $tmpfname
     * @param array $option
     * @return array 返回文件信息，包含 url, etag, size 等
     * @throws TinymengException
     */
    public function uploadFile($path, $tmpfname, $option = []){
        try{
            $path = static::normalizerPath($path);
            if (!file_exists($tmpfname)) {
                throw new TinymengException("文件不存在: {$tmpfname}");
            }
            
            $result = $this->getClient()->uploadFile($this->bucket, $path, $tmpfname, $option);
            
            if ($result === null || $result === false) {
                throw new TinymengException("文件上传失败");
            }
            
            // 构建返回信息
            $fileInfo = [
                'success' => true,
                'path' => $path,
                'key' => $path,
                'etag' => isset($result['etag']) ? trim($result['etag'], '"') : '',
                'size' => filesize($tmpfname),
            ];
            
            // 获取文件 URL
            try {
                $fileInfo['url'] = $this->getUrl($path, 0); // 0 表示永久 URL
            } catch (Exception $e) {
                // 如果获取 URL 失败，使用路径前缀构建 URL
                $fileInfo['url'] = $this->applyPathPrefix($path);
            }
            
            // 添加其他可能的响应信息
            if (isset($result['x-oss-request-id'])) {
                $fileInfo['request_id'] = $result['x-oss-request-id'];
            }
            
            return $fileInfo;
        } catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 更新文件
     * @param string $path
     * @param string $contents
     * @return array|bool|false
     */
    public function update($path, $contents)
    {
        return $this->write($path, $contents);
    }

    /**
     * 更新文件流
     * @param string $path
     * @param resource $resource
     * @return array|bool|false
     */
    public function updateStream($path, $resource){
        return $this->writeStream($path, $resource);

The expression return $this->writeStream($path, $resource) returns the type true which is incompatible with the return type mandated by tinymeng\uploads\Connector\GatewayInterface::updateStream() of array|false.

    }

    /**
     * 列出目录文件
     * @param string $directory
     * @param bool|false $recursive
     * @return array
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function listContents($directory = '', $recursive = false){

The parameter $recursive is not used and could be removed.

        try{
            $directory = static::normalizerPath($directory, true);

            $options = [
                'delimiter' => '/' ,
                'prefix'    => $directory,
                'max-keys'  => $this->config['max_keys'],
                'marker'    => '',
            ];

            $result_obj = $this->getClient()->listObjects($this->bucket, $options);

            $file_list  = $result_obj->getObjectList();//文件列表
            $dir_list   = $result_obj->getPrefixList();//文件夹列表
            $data       = [];

            if (is_array($dir_list) && count($dir_list) > 0 ) {
                foreach ($dir_list as $key => $dir) {
                    $data[] = [
                        'path'      => $dir->getPrefix(),
                        'prefix'    => $options['prefix'],
                        'marker'    => $options['marker'],
                        'file_type' => self::FILE_TYPE_DIR
                    ];
                }
            }

            if (is_array($file_list) && count($file_list) > 0 ) {
                foreach ($file_list as $key => $file) {
                    if ($key == 0 ) {
                        $data[] = [
                            'path'      => $file->getKey(),
                            'prefix'    => $options['prefix'],
                            'marker'    => $options['marker'],
                            'file_type' => self::FILE_TYPE_DIR
                        ];
                    } else {
                        $data[] = [
                            'path'              => $file->getKey(),
                            'last_modified'     => $file->getLastModified(),
                            'e_tag'             => $file->getETag(),
                            'file_size'         => $file->getSize(),
                            'prefix'            => $options['prefix'],
                            'marker'            => $options['marker'],
                            'file_type'         => self::FILE_TYPE_FILE,
                        ];
                    }
                }
            }

            return $data;
        }catch (Exception $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 获取资源的元信息，但不返回文件内容
     * @param $path
     * @return array|bool
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function getMetadata($path)
    {
        try {
            $path = static::normalizerPath($path);
            $file_info = $this->getClient()->getObjectMeta($this->bucket, $path);
            if ( !empty($file_info) ) {
                return $file_info;
            }
        }catch (OssException $e) {
            throw new TinymengException($e->getMessage());
        }
        return false;
    }

    /**
     * 获得文件大小
     * @param string $path
     * @return array
     * @author Tinymeng <666@majiameng.com>
     */
    public function getSize($path)
    {
        $file_info = $this->getMetadata($path);
        return $file_info != false && $file_info['content-length'] > 0 ? [ 'size' => $file_info['content-length'] ] : ['size' => 0];
    }

    /**
     * 获得文件Mime类型
     * @param string $path
     * @return mixed string|null
     * @author Tinymeng <666@majiameng.com>
     */
    public function getMimetype($path)
    {
        $file_info = $this->getMetadata($path);
        return $file_info != false && !empty($file_info['content-type']) ? [ 'mimetype' => $file_info['content-type'] ] : false;
    }

    /**
     * 获得文件最后修改时间
     * @param string $path
     * @return array 时间戳
     * @author Tinymeng <666@majiameng.com>
     */
    public function getTimestamp($path){
        $file_info = $this->getMetadata($path);
        return $file_info != false && !empty($file_info['last-modified'])
            ? ['timestamp' => strtotime($file_info['last-modified']) ]
            : ['timestamp' => 0 ];
    }

    /**
     * 获得文件模式 (未实现)
     * @param string $path
     * @author Tinymeng <666@majiameng.com>
     * @return string
     */
    public function getVisibility($path){

The parameter $path is not used and could be removed.

        return self::VISIBILITY_PUBLIC;
    }

    /**
     * 重命名文件
     * @param string $path
     * @param string $newpath
     * @return bool
     * @throws TinymengException
     * @internal param $oldname
     * @internal param $newname
     * @author Tinymeng <666@majiameng.com>
     */
    public function rename($path, $newpath)
    {
        try {
            /**
             * 如果是一个资源，请保持最后不是以“/”结尾！
             *
             */
            $path = static::normalizerPath($path);

            $this->getClient()->copyObject($this->bucket, $path, $this->bucket, static::normalizerPath($newpath), []);
            return $this->delete($path);
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 复制文件
     *
     * @param string $path
     * @param string $newpath
     * @return bool
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function copy($path, $newpath)
    {
        try {
            $path = static::normalizerPath($path);
            $newpath = static::normalizerPath($newpath);
            $this->getClient()->copyObject($this->bucket, $path, $this->bucket, $newpath, []);
            return true;
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 删除文件或者文件夹
     * @param string $path
     * @return bool
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function delete($path)
    {
        try{
            $path = static::normalizerPath($path);
            return $this->getClient()->deleteObject($this->bucket, $path);

The expression return $this->getClient()->deleteObject($this->bucket, $path) also could return the type array which is incompatible with the documented return type boolean.

        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 删除文件夹
     * @param string $path
     * @return mixed
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function deleteDir($path)
    {
        try{
            //递归去删除全部文件
            return $this->recursiveDelete($path);

Are you sure the usage of $this->recursiveDelete($path) targeting tinymeng\uploads\Gateways\Oss::recursiveDelete() seems to always return null.

        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 递归删除全部文件
     * @param $path
     * @author Tinymeng <666@majiameng.com>
     */
    protected function recursiveDelete($path)
    {
        $file_list = $this->listContents($path);

        // 如果当前文件夹文件不为空,则直接去删除文件夹
        if ( is_array($file_list) && count($file_list) > 0 ) {
            foreach ($file_list as $file) {
                if ($file['path'] == $path) {
                    continue;
                }
                if ($file['file_type'] == self::FILE_TYPE_FILE) {
                    $this->delete($file['path']);
                } else {
                    $this->recursiveDelete($file['path']);
                }
            }
        }

        $this->getClient()->deleteObject($this->bucket, $path);
    }

    /**
     * 创建文件夹
     * @param string $dirname
     * @return array|false
     * @throws TinymengException
     * @author Tinymeng <666@majiameng.com>
     */
    public function createDir($dirname)
    {
        try{
            return $this->getClient()->createObjectDir($this->bucket, static::normalizerPath($dirname, true));
        }catch (OssException $e){
            throw new TinymengException($e->getMessage());
        }
    }

    /**
     * 设置文件模式 (未实现)
     * @param string $path
     * @param string $visibility
     * @return bool
     * @author Tinymeng <666@majiameng.com>
     */
    public function setVisibility($path, $visibility)
    {
        return true;

The expression return true returns the type true which is incompatible with the return type mandated by tinymeng\uploads\Connector\GatewayInterface::setVisibility() of array|false.

    }

    /**
     * 获取当前文件的URL访问路径
     * @param  string $file 文件名
     * @param  integer $expire_at 有效期，单位：秒（0 表示永久有效，使用路径前缀）
     * @return string
     * @throws TinymengException
     * @author Tinymeng <879042886@qq.com>
     */
    public function getUrl($file, $expire_at = 3600)
    {
        try {
            $file = static::normalizerPath($file);

            // 处理 endpoint，去除可能包含的协议
            $endpoint = $this->config['endpoint'];
            $endpoint = preg_replace('#^https?://#', '', $endpoint);
            
            // 构建完整的基础 URL
            // 如果使用自定义域名（isCName），直接使用 endpoint，否则使用 bucket.endpoint 格式
            if (!empty($this->config['isCName'])) {
                $baseUrl = rtrim($this->config['transport'] . '://' . $endpoint, '/');
            } else {
                $baseUrl = rtrim($this->config['transport'] . '://' . $this->config['bucket'] . '.' . $endpoint, '/');
            }
            $filePath = '/' . ltrim($file, '/');
            $fullUrl = $baseUrl . $filePath;

            // 如果不需要签名 URL，直接返回完整 URL
            if ($expire_at == 0) {
                return $fullUrl;
            }

            // 生成签名 URL
            $accessUrl = $this->getClient()->signUrl($this->bucket, $file, $expire_at);
            return $accessUrl;
        } catch (OssException $e) {
            throw new TinymengException($e->getMessage());
        }
    }

}