initial commit; version 22.5.12042

libs/Phpfastcache8/Drivers/Cookie/Driver.php

@@ -0,0 +1,186 @@
+<?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)  <khoaofgod@gmail.com> https://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ *
+ */
+declare(strict_types=1);
+
+namespace Phpfastcache\Drivers\Cookie;
+
+use Phpfastcache\Core\Pool\{DriverBaseTrait, ExtendedCacheItemPoolInterface};
+use Phpfastcache\Entities\DriverStatistic;
+use Phpfastcache\Exceptions\{PhpfastcacheDriverException, PhpfastcacheInvalidArgumentException};
+use Psr\Cache\CacheItemInterface;
+
+
+/**
+ * Class Driver
+ * @package phpFastCache\Drivers
+ * @property Config $config Config object
+ * @method Config getConfig() Return the config object
+ */
+class Driver implements ExtendedCacheItemPoolInterface
+{
+    use DriverBaseTrait;
+
+    protected const PREFIX = 'PFC_';
+
+    /**
+     * @return bool
+     */
+    public function driverCheck(): bool
+    {
+        if (!$this->getConfig()->isAwareOfUntrustableData()) {
+            throw new PhpfastcacheDriverException(
+                'You have to setup the config "awareOfUntrustableData" to "TRUE" to confirm that you are aware that this driver does not use reliable storage as it may be corrupted by end-user.'
+            );
+        }
+        return function_exists('setcookie');
+    }
+
+    /**
+     * @return DriverStatistic
+     */
+    public function getStats(): DriverStatistic
+    {
+        $size = 0;
+        $stat = new DriverStatistic();
+        $stat->setData($_COOKIE);
+
+        /**
+         * Only count PFC Cookie
+         */
+        foreach ($_COOKIE as $key => $value) {
+            if (strpos($key, self::PREFIX) === 0) {
+                $size += strlen($value);
+            }
+        }
+
+        $stat->setSize($size);
+
+        return $stat;
+    }
+
+    /**
+     * @param CacheItemInterface $item
+     * @return null|array
+     * @throws PhpfastcacheDriverException
+     */
+    protected function driverRead(CacheItemInterface $item)
+    {
+        $this->driverConnect();
+        $keyword = self::PREFIX . $item->getKey();
+        $x = isset($_COOKIE[$keyword]) ? json_decode($_COOKIE[$keyword], true) : false;
+
+        if ($x == false) {
+            return null;
+        }
+
+        if (!is_scalar($this->driverUnwrapData($x)) && !is_null($this->driverUnwrapData($x))) {
+            throw new PhpfastcacheDriverException('Hacking attempt: The decoding returned a non-scalar value, Cookie driver does not allow this.');
+        }
+
+        return $x;
+    }
+
+    /**
+     * @return bool
+     */
+    protected function driverConnect(): bool
+    {
+        return !(!array_key_exists('_pfc', $_COOKIE) && !@setcookie('_pfc', '1', 10));
+    }
+
+    /**
+     * @param CacheItemInterface $item
+     * @return bool
+     * @throws PhpfastcacheInvalidArgumentException
+     */
+    protected function driverWrite(CacheItemInterface $item): bool
+    {
+        /**
+         * Check for Cross-Driver type confusion
+         */
+        if ($item instanceof Item) {
+            $this->driverConnect();
+            $keyword = self::PREFIX . $item->getKey();
+            $v = json_encode($this->driverPreWrap($item));
+
+            if ($this->getConfig()->getLimitedMemoryByObject() !== null && strlen($v) > $this->getConfig()->getLimitedMemoryByObject()) {
+                return false;
+            }
+
+            return setcookie($keyword, $v, $item->getExpirationDate()->getTimestamp(), '/');
+        }
+        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
+    }
+
+    /**
+     * @param string $key
+     * @return int
+     */
+    protected function driverReadExpirationDate($key): int
+    {
+        $this->driverConnect();
+        $keyword = self::PREFIX . $key;
+        $x = isset($_COOKIE[$keyword]) ? $this->decode(json_decode($_COOKIE[$keyword])->t) : 0;
+
+        return $x ? $x - time() : $x;
+    }
+
+    /**
+     * @param CacheItemInterface $item
+     * @return bool
+     * @throws PhpfastcacheInvalidArgumentException
+     */
+    protected function driverDelete(CacheItemInterface $item): bool
+    {
+        /**
+         * Check for Cross-Driver type confusion
+         */
+        if ($item instanceof Item) {
+            $this->driverConnect();
+            $keyword = self::PREFIX . $item->getKey();
+            $_COOKIE[$keyword] = null;
+
+            return @setcookie($keyword, null, -10);
+        }
+
+        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
+    }
+
+    /********************
+     *
+     * PSR-6 Extended Methods
+     *
+     *******************/
+
+    /**
+     * @return bool
+     */
+    protected function driverClear(): bool
+    {
+        $return = null;
+        $this->driverConnect();
+        foreach ($_COOKIE as $keyword => $value) {
+            if (strpos($keyword, self::PREFIX) !== false) {
+                $_COOKIE[$keyword] = null;
+                $result = @setcookie($keyword, null, -10);
+                if ($return !== false) {
+                    $return = $result;
+                }
+            }
+        }
+
+        return $return;
+    }
+}