DataCache util

2020-09-20 15:56:03 +03:00
parent 7aa439efbb
commit 91c5caee63
14 changed files with 581 additions and 107 deletions
@@ -0,0 +1,120 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2020 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Utils;
+
+use Espo\Core\{
+    Exceptions\Error,
+    Utils\File\Manager as FileManager,
+};
+
+use InvalidArgumentException;
+use StdClass;
+
+class DataCache
+{
+    protected $fileManager;
+
+    protected $cacheDir = 'data/cache/application/';
+
+    public function __construct(FileManager $fileManager)
+    {
+        $this->fileManager = $fileManager;
+    }
+
+    /**
+     * Whether is cached.
+     */
+    public function has(string $key) : bool
+    {
+        $cacheFile = $this->getCacheFile($key);
+
+        return $this->fileManager->isFile($cacheFile);
+    }
+
+    /**
+     * Get a stored value.
+     *
+     * @throws Error if is not cached.
+     *
+     * @return ?array|StdClass|int|float|string
+     */
+    public function get(string $key)
+    {
+        $cacheFile = $this->getCacheFile($key);
+
+        $result = $this->fileManager->getPhpContents($cacheFile);
+
+        if ($result === false) {
+            throw new Error("Could not get '{$key}'.");
+        }
+
+        return $result;
+    }
+
+    /**
+     * Store in cache.
+     *
+     * @param ?array|StdClass|int|float|string $data
+     */
+    public function store(string $key, $data)
+    {
+        if (
+            ! is_array($data) &&
+            ! $data instanceof StdClass &&
+            ! is_int($data) &&
+            ! is_float($data) &&
+            ! is_int($data)
+        ) {
+            throw new InvalidArgumentException("Bad cache data type.");
+        }
+
+        $cacheFile = $this->getCacheFile($key);
+
+        $result = $this->fileManager->putPhpContents($cacheFile, $data, true, true);
+
+        if ($result === false) {
+            throw new Error("Could not store '{$key}'.");
+        }
+    }
+
+    protected function getCacheFile(string $key) : string
+    {
+        if (
+            $key === '' ||
+            preg_match('/[^a-zA-Z0-9\/]/i', $key) ||
+            $key[0] === '/' ||
+            substr($key, -1) === '/'
+        ) {
+            throw new InvalidArgumentException("Bad cache key.");
+        }
+
+        return $this->cacheDir . $key . '.php';
+    }
+}