File::read() - Code Metrics - Inspection of "改进Cookie和Session类" - top-think/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 6.0 ( f409e2...e26961 )

by liu

created 2019-03-27 07:43 UTC

File::read() B

↳ Parent: File

Complexity

Conditions	7
Paths	5

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	15
nc	5
nop	1
dl	0
loc	27
rs	8.8333
c	0
b	0
f	0

<?php
// +----------------------------------------------------------------------

// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2019 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <[email protected]>
// +----------------------------------------------------------------------
declare (strict_types = 1);

namespace think\session\driver;

use think\App;
use think\session\SessionHandler;

class File implements SessionHandler

{
    protected $config = [
        'path'          => '',
        'expire'        => 0,
        'cache_subdir'  => true,
        'data_compress' => false,
        'serialize'     => ['serialize', 'unserialize'],
    ];

    public function __construct(App $app, array $config = [])

    {
        $this->config = array_merge($this->config, $config);

        if (empty($this->config['path'])) {
            $this->config['path'] = $app->getRuntimePath() . 'session' . DIRECTORY_SEPARATOR;
        } elseif (substr($this->config['path'], -1) != DIRECTORY_SEPARATOR) {
            $this->config['path'] .= DIRECTORY_SEPARATOR;
        }

        $this->init();
    }

    /**
     * 初始化检查
     * @access private
     * @return bool
     */
    private function init(): bool

    {
        // 创建项目缓存目录
        try {
            if (!is_dir($this->config['path']) && mkdir($this->config['path'], 0755, true)) {
                return true;
            }
        } catch (\Exception $e) {
            // 写入失败
        }

        return false;
    }

    /**
     * 取得变量的存储文件名
     * @access protected
     * @param  string $name 缓存变量名
     * @param  bool   $auto 是否自动创建目录
     * @return string
     */
    protected function getFileName(string $name, bool $auto = false): string
    {
        if ($this->config['cache_subdir']) {
            // 使用子目录
            $name = substr($name, 0, 2) . DIRECTORY_SEPARATOR . 'sess_' . $name;
        } else {
            $name = 'sess_' . $name;
        }

        $filename = $this->config['path'] . $name . '.php';
        $dir      = dirname($filename);

        if ($auto && !is_dir($dir)) {
            try {
                mkdir($dir, 0755, true);
            } catch (\Exception $e) {
                // 创建失败
            }
        }

        return $filename;
    }

    /**
     * 读取Session
     * @access public
     * @param  string $sessionId

     * @return array
     */
    public function read(string $sessionId): array
    {
        $filename = $this->getFileName($sessionId);

        if (!is_file($filename)) {
            return [];
        }

        $content = file_get_contents($filename);

        if (false !== $content) {
            $expire = (int) substr($content, 8, 12);
            if (0 != $expire && time() > filemtime($filename) + $expire) {
                //缓存过期删除缓存文件
                $this->unlink($filename);
                return [];
            }

            $content = substr($content, 32);

            if ($this->config['data_compress'] && function_exists('gzcompress')) {
                //启用数据压缩
                $content = gzuncompress($content);
            }
            return $this->unserialize($content);
        } else {
            return [];
        }
    }

    /**
     * 写入Session
     * @access public
     * @param  string $sessionId

     * @param  array  $data

     * @return array
     */
    public function write(string $sessionId, array $data): bool
    {
        $expire = $this->config['expire'];

        $expire   = $this->getExpireTime($expire);
        $filename = $this->getFileName($sessionId, true);

        $data = $this->serialize($data);

        if ($this->config['data_compress'] && function_exists('gzcompress')) {
            //数据压缩
            $data = gzcompress($data, 3);
        }

        $data   = "<?php\n//" . sprintf('%012d', $expire) . "\n exit();?>\n" . $data;
        $result = file_put_contents($filename, $data);

        if ($result) {
            clearstatcache();
            return true;

        }

        return false;

    }

    /**
     * 删除Session
     * @access public
     * @param  string $sessionId

     * @return array
     */
    public function delete(string $sessionId): bool
    {
        try {
            return $this->unlink($this->getFileName($sessionId));

        } catch (\Exception $e) {
            return false;

        }
    }

    /**
     * 获取有效期
     * @access protected
     * @param  integer|\DateTimeInterface $expire 有效期
     * @return int
     */
    protected function getExpireTime($expire): int
    {
        if ($expire instanceof \DateTimeInterface) {
            $expire = $expire->getTimestamp() - time();
        }

        return (int) $expire;
    }

    /**

     * 判断文件是否存在后，删除
     * @access private
     * @param  string $path

     * @return bool
     */
    private function unlink(string $file): bool

    {
        return is_file($file) && unlink($file);
    }

    /**
     * 序列化数据
     * @access protected
     * @param  mixed $data

     * @return string
     */
    protected function serialize($data): string
    {
        $serialize = $this->config['serialize'][0];

        return $serialize($data);
    }

    /**
     * 反序列化数据
     * @access protected
     * @param  string $data

     * @return mixed
     */
    protected function unserialize(string $data)
    {
        $unserialize = $this->config['serialize'][1];

        return $unserialize($data);
    }

}


1			<?php
2			// +----------------------------------------------------------------------
			1 ignored issue – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report You must use "/**" style comments for a file comment Loading history...
3			// \| ThinkPHP [ WE CAN DO IT JUST THINK ]
4			// +----------------------------------------------------------------------
5			// \| Copyright (c) 2006~2019 http://thinkphp.cn All rights reserved.
6			// +----------------------------------------------------------------------
7			// \| Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
8			// +----------------------------------------------------------------------
9			// \| Author: liu21st <[email protected]>
10			// +----------------------------------------------------------------------
11			declare (strict_types = 1);
12
13			namespace think\session\driver;
14
15			use think\App;
16			use think\session\SessionHandler;
17
18			class File implements SessionHandler
			1 ignored issue – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Missing class doc comment Loading history...
19			{
20			protected $config = [
21			'path' => '',
22			'expire' => 0,
23			'cache_subdir' => true,
24			'data_compress' => false,
25			'serialize' => ['serialize', 'unserialize'],
26			];
27
28			public function __construct(App $app, array $config = [])
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
29			{
30			$this->config = array_merge($this->config, $config);
31
32			if (empty($this->config['path'])) {
33			$this->config['path'] = $app->getRuntimePath() . 'session' . DIRECTORY_SEPARATOR;
34			} elseif (substr($this->config['path'], -1) != DIRECTORY_SEPARATOR) {
35			$this->config['path'] .= DIRECTORY_SEPARATOR;
36			}
37
38			$this->init();
39			}
40
41			/**
42			* 初始化检查
43			* @access private
44			* @return bool
45			*/
46			private function init(): bool
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Private method name "File::init" must be prefixed with an underscore Loading history...
47			{
48			// 创建项目缓存目录
49			try {
50			if (!is_dir($this->config['path']) && mkdir($this->config['path'], 0755, true)) {
51			return true;
52			}
53			} catch (\Exception $e) {
54			// 写入失败
55			}
56
57			return false;
58			}
59
60			/**
61			* 取得变量的存储文件名
62			* @access protected
63			* @param string $name 缓存变量名
64			* @param bool $auto 是否自动创建目录
65			* @return string
66			*/
67			protected function getFileName(string $name, bool $auto = false): string
68			{
69			if ($this->config['cache_subdir']) {
70			// 使用子目录
71			$name = substr($name, 0, 2) . DIRECTORY_SEPARATOR . 'sess_' . $name;
72			} else {
73			$name = 'sess_' . $name;
74			}
75
76			$filename = $this->config['path'] . $name . '.php';
77			$dir = dirname($filename);
78
79			if ($auto && !is_dir($dir)) {
80			try {
81			mkdir($dir, 0755, true);
82			} catch (\Exception $e) {
83			// 创建失败
84			}
85			}
86
87			return $filename;
88			}
89
90			/**
91			* 读取Session
92			* @access public
93			* @param string $sessionId
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
94			* @return array
95			*/
96			public function read(string $sessionId): array
97			{
98			$filename = $this->getFileName($sessionId);
99
100			if (!is_file($filename)) {
101			return [];
102			}
103
104			$content = file_get_contents($filename);
105
106			if (false !== $content) {
107			$expire = (int) substr($content, 8, 12);
108			if (0 != $expire && time() > filemtime($filename) + $expire) {
109			//缓存过期删除缓存文件
110			$this->unlink($filename);
111			return [];
112			}
113
114			$content = substr($content, 32);
115
116			if ($this->config['data_compress'] && function_exists('gzcompress')) {
117			//启用数据压缩
118			$content = gzuncompress($content);
119			}
120			return $this->unserialize($content);
121			} else {
122			return [];
123			}
124			}
125
126			/**
127			* 写入Session
128			* @access public
129			* @param string $sessionId
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
130			* @param array $data
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
131			* @return array
132			*/
133			public function write(string $sessionId, array $data): bool
134			{
135			$expire = $this->config['expire'];
136
137			$expire = $this->getExpireTime($expire);
138			$filename = $this->getFileName($sessionId, true);
139
140			$data = $this->serialize($data);
141
142			if ($this->config['data_compress'] && function_exists('gzcompress')) {
143			//数据压缩
144			$data = gzcompress($data, 3);
145			}
146
147			$data = "<?php\n//" . sprintf('%012d', $expire) . "\n exit();?>\n" . $data;
148			$result = file_put_contents($filename, $data);
149
150			if ($result) {
151			clearstatcache();
152			return true;
			0 ignored issues – show Bug Best Practice introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report The expression `return true` returns the type `true` which is incompatible with the documented return type `array`. Loading history...
153			}
154
155			return false;
			0 ignored issues – show Bug Best Practice introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the documented return type `array`. Loading history...
156			}
157
158			/**
159			* 删除Session
160			* @access public
161			* @param string $sessionId
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
162			* @return array
163			*/
164			public function delete(string $sessionId): bool
165			{
166			try {
167			return $this->unlink($this->getFileName($sessionId));
			0 ignored issues – show Bug Best Practice introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report The expression `return $this->unlink($th...etFileName($sessionId))` returns the type `boolean` which is incompatible with the documented return type `array`. Loading history...
168			} catch (\Exception $e) {
169			return false;
			0 ignored issues – show Bug Best Practice introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the documented return type `array`. Loading history...
170			}
171			}
172
173			/**
174			* 获取有效期
175			* @access protected
176			* @param integer\|\DateTimeInterface $expire 有效期
177			* @return int
178			*/
179			protected function getExpireTime($expire): int
180			{
181			if ($expire instanceof \DateTimeInterface) {
182			$expire = $expire->getTimestamp() - time();
183			}
184
185			return (int) $expire;
186			}
187
188			/**
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Parameter `$file` should have a doc-comment as per coding-style. Loading history...
189			* 判断文件是否存在后，删除
190			* @access private
191			* @param string $path
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Doc comment for parameter $path does not match actual variable name $file Loading history...
192			* @return bool
193			*/
194			private function unlink(string $file): bool
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Private method name "File::unlink" must be prefixed with an underscore Loading history...
195			{
196			return is_file($file) && unlink($file);
197			}
198
199			/**
200			* 序列化数据
201			* @access protected
202			* @param mixed $data
			0 ignored issues – show Coding Style introduced 2019-03-27 07:45 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
203			* @return string
204			*/
205			protected function serialize($data): string
206			{
207			$serialize = $this->config['serialize'][0];
208
209			return $serialize($data);
210			}
211
212			/**
213			* 反序列化数据
214			* @access protected
215			* @param string $data
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
216			* @return mixed
217			*/
218			protected function unserialize(string $data)
219			{
220			$unserialize = $this->config['serialize'][1];
221
222			return $unserialize($data);
223			}
224
225			}
226

top-think / framework

Push — 6.0 ( f409e2...e26961 )

File::read() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like