'lib' rewritten.

2018-03-02 22:56:13 +01:00
parent ed5ec82479
commit c1cc89f456
62 changed files with 4788 additions and 2971 deletions
--- a/lib/Properties.php
+++ b/lib/Properties.php
@@ -0,0 +1,211 @@
+<?php
+/**
+ * Nextcloud - user_sql
+ *
+ * @copyright 2018 Marcin Łojewski <dev@mlojewski.me>
+ * @author    Marcin Łojewski <dev@mlojewski.me>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace OCA\UserSQL;
+
+use OCA\UserSQL\Constant\App;
+use OCA\UserSQL\Constant\DB;
+use OCA\UserSQL\Constant\Opt;
+use OCP\IConfig;
+use OCP\ILogger;
+
+/**
+ * Store and retrieve application properties.
+ *
+ * @author Marcin Łojewski <dev@mlojewski.me>
+ */
+class Properties implements \ArrayAccess
+{
+    /**
+     * @var string The cache key name.
+     */
+    const CACHE_KEY = "Properties_data";
+
+    /**
+     * @var string The application name.
+     */
+    private $appName;
+    /**
+     * @var IConfig The config instance.
+     */
+    private $config;
+    /**
+     * @var ILogger The logger instance.
+     */
+    private $logger;
+    /**
+     * @var Cache The cache instance.
+     */
+    private $cache;
+    /**
+     * @var array The properties array.
+     */
+    private $data;
+
+    /**
+     * The default constructor.
+     *
+     * @param string  $AppName The application name.
+     * @param IConfig $config  The config instance.
+     * @param ILogger $logger  The logger instance.
+     * @param Cache   $cache   The cache instance.
+     */
+    public function __construct(
+        $AppName, IConfig $config, ILogger $logger, Cache $cache
+    ) {
+        $this->appName = $AppName;
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->cache = $cache;
+
+        $this->loadProperties();
+    }
+
+    /**
+     * Load the application properties.
+     *
+     * First the values are fetched from the cache memory.
+     * If these are not available, the database values are fetched.
+     */
+    private function loadProperties()
+    {
+        $this->data = $this->cache->get(self::CACHE_KEY);
+
+        if (!is_null($this->data)) {
+            return;
+        }
+
+        $params = $this->getParameterArray();
+        $this->data = [];
+
+        foreach ($params as $param) {
+            $value = $this->config->getAppValue($this->appName, $param, null);
+
+            if ($value === App::FALSE_VALUE) {
+                $value = false;
+            } elseif ($value === App::TRUE_VALUE) {
+                $value = true;
+            }
+
+            $this->data[$param] = $value;
+        }
+
+        $this->store();
+
+        $this->logger->debug(
+            "The application properties has been loaded.",
+            ["app" => $this->appName]
+        );
+    }
+
+    /**
+     * Return an array with all supported parameters.
+     *
+     * @return array Array containing strings of the parameters.
+     */
+    private function getParameterArray()
+    {
+        $params = [];
+
+        foreach ([DB::class, Opt::class] as $class) {
+            try {
+                $reflection = new \ReflectionClass($class);
+                $params = array_merge(
+                    $params, array_values($reflection->getConstants())
+                );
+            } catch (\ReflectionException $exception) {
+                $this->logger->logException(
+                    $exception, ["app" => $this->appName]
+                );
+            }
+        }
+
+        return $params;
+    }
+
+    /**
+     * Store properties in the cache memory.
+     */
+    private function store()
+    {
+        $this->cache->set(self::CACHE_KEY, $this->data);
+    }
+
+    /**
+     * Get properties array.
+     *
+     * @return array The properties array.
+     */
+    public function getArray()
+    {
+        return $this->data;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function offsetExists($offset)
+    {
+        return isset($this->data[$offset]);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function offsetGet($offset)
+    {
+        if (isset($this->data[$offset])) {
+            return $this->data[$offset];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function offsetSet($offset, $value)
+    {
+        $this->config->setAppValue($this->appName, $offset, $value);
+
+        if ($value === App::FALSE_VALUE) {
+            $value = false;
+        } elseif ($value === App::TRUE_VALUE) {
+            $value = true;
+        }
+
+        $this->data[$offset] = $value;
+
+        if ($offset === Opt::USE_CACHE && $value === false) {
+            $this->cache->clear();
+        } else {
+            $this->store();
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function offsetUnset($offset)
+    {
+        unset($this->data[$offset]);
+    }
+}