Merge branch 'master' into translations

[bookstack] / app / Services / SettingService.php

diff --git a/app/Services/SettingService.php b/app/Services/SettingService.php
index b7215f5241f69832b3106488ca8a4d827bad7227..bf5fa918e2b54cf7aadda0f6ff18c0875311d058 100644 (file)
--- a/app/Services/SettingService.php
+++ b/app/Services/SettingService.php
@@ -1,26 +1,32 @@
-<?php namespace Oxbow\Services;
+<?php namespace BookStack\Services;
 
-use Oxbow\Setting;
+use BookStack\Setting;
+use Illuminate\Contracts\Cache\Repository as Cache;
 
 /**
  * Class SettingService
  *
  * The settings are a simple key-value database store.
  *
- * @package Oxbow\Services
+ * @package BookStack\Services
  */
 class SettingService
 {
 
     protected $setting;
+    protected $cache;
+
+    protected $cachePrefix = 'setting-';
 
     /**
      * SettingService constructor.
-     * @param $setting
+     * @param Setting $setting
+     * @param Cache   $cache
      */
-    public function __construct(Setting $setting)
+    public function __construct(Setting $setting, Cache $cache)
     {
         $this->setting = $setting;
+        $this->cache = $cache;
     }
 
     /**
@@ -32,17 +38,73 @@ class SettingService
      */
     public function get($key, $default = false)
     {
-        $setting = $this->getSettingObjectByKey($key);
-        $value = $setting === null ? null : $setting->value;
+        $value = $this->getValueFromStore($key, $default);
+        return $this->formatValue($value, $default);
+    }
+
+    /**
+     * Gets a setting value from the cache or database.
+     * Looks at the system defaults if not cached or in database.
+     * @param $key
+     * @param $default
+     * @return mixed
+     */
+    protected function getValueFromStore($key, $default)
+    {
+        // Check for an overriding value
+        $overrideValue = $this->getOverrideValue($key);
+        if ($overrideValue !== null) return $overrideValue;
+
+        // Check the cache
+        $cacheKey = $this->cachePrefix . $key;
+        if ($this->cache->has($cacheKey)) {
+            return $this->cache->get($cacheKey);
+        }
+
+        // Check the database
+        $settingObject = $this->getSettingObjectByKey($key);
+        if ($settingObject !== null) {
+            $value = $settingObject->value;
+            $this->cache->forever($cacheKey, $value);
+            return $value;
+        }
+
+        // Check the defaults set in the app config.
+        $configPrefix = 'setting-defaults.' . $key;
+        if (config()->has($configPrefix)) {
+            $value = config($configPrefix);
+            $this->cache->forever($cacheKey, $value);
+            return $value;
+        }
+
+        return $default;
+    }
+
+    /**
+     * Clear an item from the cache completely.
+     * @param $key
+     */
+    protected function clearFromCache($key)
+    {
+        $cacheKey = $this->cachePrefix . $key;
+        $this->cache->forget($cacheKey);
+    }
 
+    /**
+     * Format a settings value
+     * @param $value
+     * @param $default
+     * @return mixed
+     */
+    protected function formatValue($value, $default)
+    {
         // Change string booleans to actual booleans
-        if($value === 'true') $value = true;
-        if($value === 'false') $value = false;
+        if ($value === 'true') $value = true;
+        if ($value === 'false') $value = false;
 
         // Set to default if empty
-        if($value === '') $value = $default;
-
-        return $value === null ? $default : $value;
+        if ($value === '') $value = $default;
+        return $value;
     }
 
     /**
@@ -69,6 +131,7 @@ class SettingService
         ]);
         $setting->value = $value;
         $setting->save();
+        $this->clearFromCache($key);
         return true;
     }
 
@@ -83,6 +146,7 @@ class SettingService
         if ($setting) {
             $setting->delete();
         }
+        $this->clearFromCache($key);
         return true;
     }
 
@@ -91,9 +155,23 @@ class SettingService
      * @param $key
      * @return mixed
      */
-    private function getSettingObjectByKey($key)
+    protected function getSettingObjectByKey($key)
     {
         return $this->setting->where('setting_key', '=', $key)->first();
     }
 
+
+    /**
+     * Returns an override value for a setting based on certain app conditions.
+     * Used where certain configuration options overrule others.
+     * Returns null if no override value is available.
+     * @param $key
+     * @return bool|null
+     */
+    protected function getOverrideValue($key)
+    {
+        if ($key === 'registration-enabled' && config('auth.method') === 'ldap') return false;
+        return null;
+    }
+
 }
\ No newline at end of file