DriverBaseTrait::__wakeup() - Code Metrics - Inspection of "Improved raw data for driver Files" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v5 ( c22ae7...d83136 )

by Georges

created 2016-05-15 16:08 UTC

DriverBaseTrait::__wakeup() A

↳ Parent: DriverBaseTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	2
eloc	5
c	1
b	1
f	0
nc	2
nop	0
dl	0
loc	8
rs	9.4285

<?php
/**
 *
 * This file is part of phpFastCache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt file.
 *
 * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 *
 */
namespace phpFastCache\Cache;

use phpFastCache\Core\ExtendedCacheItemPoolTrait;
use phpFastCache\Exceptions\phpFastCacheDriverException;

/**
 * Class DriverBaseTrait
 * @package phpFastCache\Cache
 */
trait DriverBaseTrait
{
    use ExtendedCacheItemPoolTrait;

    /**
     * @var array default options, this will be merge to Driver's Options
     */
    protected $config = [];

    /**
     * @var bool
     */
    protected $fallback = false;

    /**
     * @var mixed Instance of driver service
     */
    protected $instance;

    /**
     * @param $keyword
     * @return string
     */
    protected function encodeFilename($keyword)
    {
        return md5($keyword);
    }

    /**
     * @param $config_name
     * @param string $value
     */
    public function setup($config_name, $value = '')
    {
        /**
         * Config for class
         */
        if (is_array($config_name)) {
            $this->config = array_merge($this->config, $config_name);
        } else {
            $this->config[ $config_name ] = $value;
        }
    }

    /**
     * @return array
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * @param $file
     * @return string
     * @throws \Exception
     */
    protected function readfile($file)
    {
        if (function_exists('file_get_contents')) {
            return file_get_contents($file);
if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) {
    throw new \InvalidArgumentException('This input is not allowed.');
}
        } else {
            $string = '';

            $file_handle = @fopen($file, 'r');
            if (!$file_handle) {
                throw new phpFastCacheDriverException("Can't Read File", 96);

            }
            while (!feof($file_handle)) {
                $line = fgets($file_handle);
                $string .= $line;
            }
            fclose($file_handle);

            return $string;
        }
    }

    /**
     * Encode data types such as object/array
     * for driver that does not support
     * non-scalar value
     * @param $data
     * @return string
     */
    protected function encode($data)
    {
        return serialize($data);
    }

    /**
     * Decode data types such as object/array
     * for driver that does not support
     * non-scalar value
     * @param $value
     * @return mixed
     */
    protected function decode($value)
    {
        $x = @unserialize($value);
if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) {
    throw new \InvalidArgumentException('This input is not allowed.');
}
        if ($x == false) {
            return $value;
        } else {
            return $x;
        }
    }

    /**
     * Check phpModules or CGI
     * @return bool
     */
    protected function isPHPModule()
    {
        if (PHP_SAPI === 'apache2handler') {
            return true;
        } else {
            if (strpos(PHP_SAPI, 'handler') !== false) {
                return true;
            }
        }

        return false;
    }


    /**
     * @param $class
     * @return bool
     */
    protected function isExistingDriver($class)
    {
        return class_exists("\\phpFastCache\\Drivers\\{$class}");
    }


    /**
     * @param $tag
     * @return string
     */
    protected function _getTagName($tag)
    {
        return "__tag__" . $tag;
    }

    /**
     * @param \phpFastCache\Cache\ExtendedCacheItemInterface $item
     * @return array
     */
    public function driverPreWrap(ExtendedCacheItemInterface $item)
    {
        return [
          self::DRIVER_DATA_WRAPPER_INDEX => $item->get(),
          self::DRIVER_TIME_WRAPPER_INDEX => $item->getExpirationDate(),
          self::DRIVER_TAGS_WRAPPER_INDEX => $item->getTags(),
        ];
    }

    /**
     * @param array $wrapper
     * @return mixed
     */
    public function driverUnwrapData(array $wrapper)
    {
        return $wrapper[ self::DRIVER_DATA_WRAPPER_INDEX ];
    }

    /**
     * @param array $wrapper
     * @return mixed
     */
    public function driverUnwrapTags(array $wrapper)
    {
        return $wrapper[ self::DRIVER_TAGS_WRAPPER_INDEX ];
    }


    /**
     * @param array $wrapper
     * @return \DateTime
     */
    public function driverUnwrapTime(array $wrapper)
    {
        return $wrapper[ self::DRIVER_TIME_WRAPPER_INDEX ];
    }

    /**
     * @return string
     */
    public function getDriverName()
    {
        static $driverName;

        return ($driverName ?: $driverName = ucfirst(substr(strrchr((new \ReflectionObject($this))->getNamespaceName(), '\\'), 1)));
    }

    /**
     * @param \phpFastCache\Cache\ExtendedCacheItemInterface $item
     * @return bool
     */
    public function driverWriteTags(ExtendedCacheItemInterface $item)
    {
        $tagsItems = $this->getItems($this->getTagKeys($item->getTags()));


        foreach ($tagsItems as $tagsItem) {
            $data = $tagsItem->get();
            $expTimestamp = $item->getExpirationDate()->getTimestamp();

            /**
             * Using the key will
             * avoid to use array_unique
             * that has slow performances
             */

            $tagsItem->set(array_merge((array) $data, [$item->getKey() => $expTimestamp]));

            /**
             * Set the expiration date
             * of the $tagsItem based
             * on the older $item
             * expiration date
             */
            if ($expTimestamp > $tagsItem->getExpirationDate()->getTimestamp()) {
                $tagsItem->expiresAt($item->getExpirationDate());
            }
            $this->driverWrite($tagsItem);

        }

        /**
         * Also update removed tags to
         * keep the index up to date
         */
        $tagsItems = $this->getItems($this->getTagKeys($item->getRemovedTags()));


        foreach ($tagsItems as $tagsItem) {
            $data = (array) $tagsItem->get();

            unset($data[ $item->getKey() ]);
            $tagsItem->set($data);

            /**
             * Recalculate the expiration date
             *
             * If the $tagsItem does not have
             * any cache item references left
             * then remove it from tagsItems index
             */
            if (count($data)) {
                $tagsItem->expiresAt(max($data));
                $this->driverWrite($tagsItem);

            } else {
                $this->driverDelete($tagsItem);
            }
        }

        return true;
    }

    /**
     * @param $key
     * @return string
     */
    public function getTagKey($key)
    {
        return self::DRIVER_TAGS_KEY_PREFIX . $key;
    }

    /**
     * @param $key
     * @return string
     */
    public function getTagKeys(array $keys)
    {
        foreach ($keys as &$key) {
            $key = $this->getTagKey($key);
        }

        return $keys;
    }

    /**
     * @param string $optionName
     * @param mixed $optionValue
     * @return bool
     * @throws \InvalidArgumentException
     */
    public static function isValidOption($optionName, $optionValue)

    {
        if(!is_string($optionName))
        {
            throw new \InvalidArgumentException('$optionName must be a string');
        }
        return true;
    }

    /**
     * @return array
     */
    public static function getRequiredOptions()
    {
        return [];
    }

    /**
     * @return array
     */
    public static function getValidOptions()
    {
        return [];
    }

    /**
     * Serialization protection for frameworks
     * with profiler such as Symfony, etc.
     */
    public function __sleep()
    {
        $this->itemInstances = array_keys($this->itemInstances);

        return (array) array_keys(get_object_vars($this));
    }

    /**
     * Serialization protection for frameworks
     * with profiler such as Symfony, etc.
     */
    public function __wakeup()
    {
        $itemInstances = $this->itemInstances;

        $this->itemInstances = [];

        foreach ($itemInstances as $itemInstance) {
            $this->itemInstances[$itemInstance] = $this->getItem($itemInstance);

        }
    }
}

Push — v5 ( c22ae7...d83136 )

DriverBaseTrait::__wakeup() A

Complexity

Size

Duplication

Importance

General Strategies to prevent injection

General Strategies to prevent injection

1			<?php
2			/**
3			*
4			* This file is part of phpFastCache.
5			*
6			* @license MIT License (MIT)
7			*
8			* For full copyright and license information, please see the docs/CREDITS.txt file.
9			*
10			* @author Khoa Bui (khoaofgod) <[email protected]> http://www.phpfastcache.com
11			* @author Georges.L (Geolim4) <[email protected]>
12			*
13			*/
14			namespace phpFastCache\Cache;
15
16			use phpFastCache\Core\ExtendedCacheItemPoolTrait;
17			use phpFastCache\Exceptions\phpFastCacheDriverException;
18
19			/**
20			* Class DriverBaseTrait
21			* @package phpFastCache\Cache
22			*/
23			trait DriverBaseTrait
24			{
25			use ExtendedCacheItemPoolTrait;
26
27			/**
28			* @var array default options, this will be merge to Driver's Options
29			*/
30			protected $config = [];
31
32			/**
33			* @var bool
34			*/
35			protected $fallback = false;
36
37			/**
38			* @var mixed Instance of driver service
39			*/
40			protected $instance;
41
42			/**
43			* @param $keyword
44			* @return string
45			*/
46			protected function encodeFilename($keyword)
47			{
48			return md5($keyword);
49			}
50
51			/**
52			* @param $config_name
53			* @param string $value
54			*/
55			public function setup($config_name, $value = '')
56			{
57			/**
58			* Config for class
59			*/
60			if (is_array($config_name)) {
61			$this->config = array_merge($this->config, $config_name);
62			} else {
63			$this->config[ $config_name ] = $value;
64			}
65			}
66
67			/**
68			* @return array
69			*/
70			public function getConfig()
71			{
72			return $this->config;
73			}
74
75			/**
76			* @param $file
77			* @return string
78			* @throws \Exception
79			*/
80			protected function readfile($file)
81			{
82			if (function_exists('file_get_contents')) {
83			return file_get_contents($file);
			0 ignored issues – show Security File Exposure introduced 2016-05-15 02:13 UTC by Report Bug Copy Issue Report `$file` can contain request data and is used in file inclusion context(s) leading to a potential security vulnerability. General Strategies to prevent injection In general, it is advisable to prevent any user-data to reach this point. This can be done by white-listing certain values: if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) { throw new \InvalidArgumentException('This input is not allowed.'); } For numeric data, we recommend to explicitly cast the data: $sanitized = (integer) $tainted; Loading history...
84			} else {
85			$string = '';
86
87			$file_handle = @fopen($file, 'r');
88			if (!$file_handle) {
89			throw new phpFastCacheDriverException("Can't Read File", 96);
90
91			}
92			while (!feof($file_handle)) {
93			$line = fgets($file_handle);
94			$string .= $line;
95			}
96			fclose($file_handle);
97
98			return $string;
99			}
100			}
101
102			/**
103			* Encode data types such as object/array
104			* for driver that does not support
105			* non-scalar value
106			* @param $data
107			* @return string
108			*/
109			protected function encode($data)
110			{
111			return serialize($data);
112			}
113
114			/**
115			* Decode data types such as object/array
116			* for driver that does not support
117			* non-scalar value
118			* @param $value
119			* @return mixed
120			*/
121			protected function decode($value)
122			{
123			$x = @unserialize($value);
			0 ignored issues – show Security Object Injection introduced 2016-05-15 02:13 UTC by Report Bug Copy Issue Report `$value` can contain request data and is used in unserialized context(s) leading to a potential security vulnerability. General Strategies to prevent injection In general, it is advisable to prevent any user-data to reach this point. This can be done by white-listing certain values: if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) { throw new \InvalidArgumentException('This input is not allowed.'); } For numeric data, we recommend to explicitly cast the data: $sanitized = (integer) $tainted; Loading history...
124			if ($x == false) {
125			return $value;
126			} else {
127			return $x;
128			}
129			}
130
131			/**
132			* Check phpModules or CGI
133			* @return bool
134			*/
135			protected function isPHPModule()
136			{
137			if (PHP_SAPI === 'apache2handler') {
138			return true;
139			} else {
140			if (strpos(PHP_SAPI, 'handler') !== false) {
141			return true;
142			}
143			}
144
145			return false;
146			}
147
148
149			/**
150			* @param $class
151			* @return bool
152			*/
153			protected function isExistingDriver($class)
154			{
155			return class_exists("\\phpFastCache\\Drivers\\{$class}");
156			}
157
158
159			/**
160			* @param $tag
161			* @return string
162			*/
163			protected function _getTagName($tag)
164			{
165			return "__tag__" . $tag;
166			}
167
168			/**
169			* @param \phpFastCache\Cache\ExtendedCacheItemInterface $item
170			* @return array
171			*/
172			public function driverPreWrap(ExtendedCacheItemInterface $item)
173			{
174			return [
175			self::DRIVER_DATA_WRAPPER_INDEX => $item->get(),
176			self::DRIVER_TIME_WRAPPER_INDEX => $item->getExpirationDate(),
177			self::DRIVER_TAGS_WRAPPER_INDEX => $item->getTags(),
178			];
179			}
180
181			/**
182			* @param array $wrapper
183			* @return mixed
184			*/
185			public function driverUnwrapData(array $wrapper)
186			{
187			return $wrapper[ self::DRIVER_DATA_WRAPPER_INDEX ];
188			}
189
190			/**
191			* @param array $wrapper
192			* @return mixed
193			*/
194			public function driverUnwrapTags(array $wrapper)
195			{
196			return $wrapper[ self::DRIVER_TAGS_WRAPPER_INDEX ];
197			}
198
199
200			/**
201			* @param array $wrapper
202			* @return \DateTime
203			*/
204			public function driverUnwrapTime(array $wrapper)
205			{
206			return $wrapper[ self::DRIVER_TIME_WRAPPER_INDEX ];
207			}
208
209			/**
210			* @return string
211			*/
212			public function getDriverName()
213			{
214			static $driverName;
215
216			return ($driverName ?: $driverName = ucfirst(substr(strrchr((new \ReflectionObject($this))->getNamespaceName(), '\\'), 1)));
217			}
218
219			/**
220			* @param \phpFastCache\Cache\ExtendedCacheItemInterface $item
221			* @return bool
222			*/
223			public function driverWriteTags(ExtendedCacheItemInterface $item)
224			{
225			$tagsItems = $this->getItems($this->getTagKeys($item->getTags()));
			1 ignored issue – show Bug introduced 2016-05-13 23:15 UTC by Report Bug Copy Issue Report The method `getItems()` does not exist on `phpFastCache\Cache\DriverBaseTrait`. Did you maybe mean `getItemsByTag()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
226
227			foreach ($tagsItems as $tagsItem) {
228			$data = $tagsItem->get();
229			$expTimestamp = $item->getExpirationDate()->getTimestamp();
230
231			/**
232			* Using the key will
233			* avoid to use array_unique
234			* that has slow performances
235			*/
236
237			$tagsItem->set(array_merge((array) $data, [$item->getKey() => $expTimestamp]));
238
239			/**
240			* Set the expiration date
241			* of the $tagsItem based
242			* on the older $item
243			* expiration date
244			*/
245			if ($expTimestamp > $tagsItem->getExpirationDate()->getTimestamp()) {
246			$tagsItem->expiresAt($item->getExpirationDate());
247			}
248			$this->driverWrite($tagsItem);
			1 ignored issue – show Bug introduced 2016-05-13 23:06 UTC by Report Bug Copy Issue Report The method `driverWrite()` does not exist on `phpFastCache\Cache\DriverBaseTrait`. Did you maybe mean `driverWriteTags()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
249			}
250
251			/**
252			* Also update removed tags to
253			* keep the index up to date
254			*/
255			$tagsItems = $this->getItems($this->getTagKeys($item->getRemovedTags()));
			1 ignored issue – show Bug introduced 2016-05-13 23:15 UTC by Report Bug Copy Issue Report The method `getItems()` does not exist on `phpFastCache\Cache\DriverBaseTrait`. Did you maybe mean `getItemsByTag()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
256
257			foreach ($tagsItems as $tagsItem) {
258			$data = (array) $tagsItem->get();
259
260			unset($data[ $item->getKey() ]);
261			$tagsItem->set($data);
262
263			/**
264			* Recalculate the expiration date
265			*
266			* If the $tagsItem does not have
267			* any cache item references left
268			* then remove it from tagsItems index
269			*/
270			if (count($data)) {
271			$tagsItem->expiresAt(max($data));
272			$this->driverWrite($tagsItem);
			1 ignored issue – show Bug introduced 2016-05-13 23:06 UTC by Report Bug Copy Issue Report The method `driverWrite()` does not exist on `phpFastCache\Cache\DriverBaseTrait`. Did you maybe mean `driverWriteTags()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
273			} else {
274			$this->driverDelete($tagsItem);
275			}
276			}
277
278			return true;
279			}
280
281			/**
282			* @param $key
283			* @return string
284			*/
285			public function getTagKey($key)
286			{
287			return self::DRIVER_TAGS_KEY_PREFIX . $key;
288			}
289
290			/**
291			* @param $key
292			* @return string
293			*/
294			public function getTagKeys(array $keys)
295			{
296			foreach ($keys as &$key) {
297			$key = $this->getTagKey($key);
298			}
299
300			return $keys;
301			}
302
303			/**
304			* @param string $optionName
305			* @param mixed $optionValue
306			* @return bool
307			* @throws \InvalidArgumentException
308			*/
309			public static function isValidOption($optionName, $optionValue)
			1 ignored issue – show Unused Code introduced 2016-05-14 15:03 UTC by Report Bug Copy Issue Report The parameter `$optionValue` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
310			{
311			if(!is_string($optionName))
312			{
313			throw new \InvalidArgumentException('$optionName must be a string');
314			}
315			return true;
316			}
317
318			/**
319			* @return array
320			*/
321			public static function getRequiredOptions()
322			{
323			return [];
324			}
325
326			/**
327			* @return array
328			*/
329			public static function getValidOptions()
330			{
331			return [];
332			}
333
334			/**
335			* Serialization protection for frameworks
336			* with profiler such as Symfony, etc.
337			*/
338			public function __sleep()
339			{
340			$this->itemInstances = array_keys($this->itemInstances);
			0 ignored issues – show Bug introduced 2016-05-15 16:10 UTC by Report Bug Copy Issue Report The property `itemInstances` does not seem to exist. Did you mean `instance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
341			return (array) array_keys(get_object_vars($this));
342			}
343
344			/**
345			* Serialization protection for frameworks
346			* with profiler such as Symfony, etc.
347			*/
348			public function __wakeup()
349			{
350			$itemInstances = $this->itemInstances;
			0 ignored issues – show Bug introduced 2016-05-15 16:10 UTC by Report Bug Copy Issue Report The property `itemInstances` does not seem to exist. Did you mean `instance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
351			$this->itemInstances = [];
			0 ignored issues – show Bug introduced 2016-05-15 16:10 UTC by Report Bug Copy Issue Report The property `itemInstances` does not seem to exist. Did you mean `instance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
352			foreach ($itemInstances as $itemInstance) {
353			$this->itemInstances[$itemInstance] = $this->getItem($itemInstance);
			1 ignored issue – show Bug introduced 2016-05-15 16:10 UTC by Report Bug Copy Issue Report The property `itemInstances` does not seem to exist. Did you mean `instance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Bug introduced 2016-05-15 16:10 UTC by Report Bug Copy Issue Report The method `getItem()` does not exist on `phpFastCache\Cache\DriverBaseTrait`. Did you maybe mean `getItemsByTag()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
354			}
355			}
356			}

PHPSocialNetwork / phpfastcache

Push — v5 ( c22ae7...d83136 )

DriverBaseTrait::__wakeup() A

Complexity

Size

Duplication

Importance

General Strategies to prevent injection

General Strategies to prevent injection

Duplication Side-by-Side

Filter issues like