Added OIDC group sync functionality

[bookstack] / app / Settings / SettingService.php

diff --git a/app/Settings/SettingService.php b/app/Settings/SettingService.php
index 1c053b3848ea779d480adea01834dce0059d629d..f2c4c8305c47c2db227a79456e880422171dc500 100644 (file)
--- a/app/Settings/SettingService.php
+++ b/app/Settings/SettingService.php
@@ -1,5 +1,8 @@
-<?php namespace BookStack\Settings;
+<?php

 
 

+namespace BookStack\Settings;
+
+use BookStack\Auth\User;

 use Illuminate\Contracts\Cache\Repository as Cache;
 
 /**
 use Illuminate\Contracts\Cache\Repository as Cache;
 
 /**


@@ -9,7 +12,6 @@ use Illuminate\Contracts\Cache\Repository as Cache;
  */
 class SettingService
 {
  */
 class SettingService
 {

-

     protected $setting;
     protected $cache;
     protected $localCache = [];
     protected $setting;
     protected $cache;
     protected $localCache = [];


@@ -18,8 +20,6 @@ class SettingService
 
     /**
      * SettingService constructor.
 
     /**
      * SettingService constructor.

-     * @param Setting $setting
-     * @param Cache   $cache

      */
     public function __construct(Setting $setting, Cache $cache)
     {
      */
     public function __construct(Setting $setting, Cache $cache)
     {


@@ -30,13 +30,10 @@ class SettingService
     /**
      * Gets a setting from the database,
      * If not found, Returns default, Which is false by default.
     /**
      * Gets a setting from the database,
      * If not found, Returns default, Which is false by default.

-     * @param             $key
-     * @param string|bool $default
-     * @return bool|string

      */
      */

-    public function get($key, $default = false)
+    public function get(string $key, $default = null)

     {
     {

-        if ($default === false) {
+        if (is_null($default)) {

             $default = config('setting-defaults.' . $key, false);
         }
 
             $default = config('setting-defaults.' . $key, false);
         }
 


@@ -44,47 +41,43 @@ class SettingService
             return $this->localCache[$key];
         }
 
             return $this->localCache[$key];
         }
 

-        $value = $this->getValueFromStore($key, $default);
+        $value = $this->getValueFromStore($key) ?? $default;

         $formatted = $this->formatValue($value, $default);
         $this->localCache[$key] = $formatted;
         $formatted = $this->formatValue($value, $default);
         $this->localCache[$key] = $formatted;

+

         return $formatted;
     }
 
     /**
      * Get a value from the session instead of the main store option.
         return $formatted;
     }
 
     /**
      * Get a value from the session instead of the main store option.

-     * @param $key
-     * @param bool $default
-     * @return mixed

      */
      */

-    protected function getFromSession($key, $default = false)
+    protected function getFromSession(string $key, $default = false)

     {
         $value = session()->get($key, $default);
     {
         $value = session()->get($key, $default);

-        $formatted = $this->formatValue($value, $default);
-        return $formatted;
+
+        return $this->formatValue($value, $default);

     }
 
     /**
      * Get a user-specific setting from the database or cache.
     }
 
     /**
      * Get a user-specific setting from the database or cache.

-     * @param \BookStack\Auth\User $user
-     * @param $key
-     * @param bool $default
-     * @return bool|string

      */
      */

-    public function getUser($user, $key, $default = false)
+    public function getUser(User $user, string $key, $default = null)

     {
     {

+        if (is_null($default)) {
+            $default = config('setting-defaults.user.' . $key, false);
+        }
+

         if ($user->isDefault()) {
             return $this->getFromSession($key, $default);
         }
         if ($user->isDefault()) {
             return $this->getFromSession($key, $default);
         }

+

         return $this->get($this->userKey($user->id, $key), $default);
     }
 
     /**
      * Get a value for the current logged-in user.
         return $this->get($this->userKey($user->id, $key), $default);
     }
 
     /**
      * Get a value for the current logged-in user.

-     * @param $key
-     * @param bool $default
-     * @return bool|string

      */
      */

-    public function getForCurrentUser($key, $default = false)
+    public function getForCurrentUser(string $key, $default = null)

     {
         return $this->getUser(user(), $key, $default);
     }
     {
         return $this->getUser(user(), $key, $default);
     }


@@ -92,11 +85,9 @@ class SettingService
     /**
      * Gets a setting value from the cache or database.
      * Looks at the system defaults if not cached or in database.
     /**
      * 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
+     * Returns null if nothing is found.

      */
      */

-    protected function getValueFromStore($key, $default)
+    protected function getValueFromStore(string $key)

     {
         // Check the cache
         $cacheKey = $this->cachePrefix . $key;
     {
         // Check the cache
         $cacheKey = $this->cachePrefix . $key;


@@ -109,18 +100,23 @@ class SettingService
         $settingObject = $this->getSettingObjectByKey($key);
         if ($settingObject !== null) {
             $value = $settingObject->value;
         $settingObject = $this->getSettingObjectByKey($key);
         if ($settingObject !== null) {
             $value = $settingObject->value;

+
+            if ($settingObject->type === 'array') {
+                $value = json_decode($value, true) ?? [];
+            }
+

             $this->cache->forever($cacheKey, $value);
             $this->cache->forever($cacheKey, $value);

+

             return $value;
         }
 
             return $value;
         }
 

-        return $default;
+        return null;

     }
 
     /**
      * Clear an item from the cache completely.
     }
 
     /**
      * Clear an item from the cache completely.

-     * @param $key

      */
      */

-    protected function clearFromCache($key)
+    protected function clearFromCache(string $key)

     {
         $cacheKey = $this->cachePrefix . $key;
         $this->cache->forget($cacheKey);
     {
         $cacheKey = $this->cachePrefix . $key;
         $this->cache->forget($cacheKey);


@@ -130,18 +126,14 @@ class SettingService
     }
 
     /**
     }
 
     /**

-     * Format a settings value
-     * @param $value
-     * @param $default
-     * @return mixed
+     * Format a settings value.

      */
     protected function formatValue($value, $default)
     {
         // Change string booleans to actual booleans
         if ($value === 'true') {
             $value = true;
      */
     protected function formatValue($value, $default)
     {
         // Change string booleans to actual booleans
         if ($value === 'true') {
             $value = true;

-        }
-        if ($value === 'false') {
+        } elseif ($value === 'false') {

             $value = false;
         }
 
             $value = false;
         }
 


@@ -149,104 +141,107 @@ class SettingService
         if ($value === '') {
             $value = $default;
         }
         if ($value === '') {
             $value = $default;
         }

+

         return $value;
     }
 
     /**
      * Checks if a setting exists.
         return $value;
     }
 
     /**
      * Checks if a setting exists.

-     * @param $key
-     * @return bool

      */
      */

-    public function has($key)
+    public function has(string $key): bool

     {
         $setting = $this->getSettingObjectByKey($key);
     {
         $setting = $this->getSettingObjectByKey($key);

-        return $setting !== null;
-    }

 
 

-    /**
-     * Check if a user setting is in the database.
-     * @param $key
-     * @return bool
-     */
-    public function hasUser($key)
-    {
-        return $this->has($this->userKey($key));
+        return $setting !== null;

     }
 
     /**
      * Add a setting to the database.
     }
 
     /**
      * Add a setting to the database.

-     * @param $key
-     * @param $value
-     * @return bool
+     * Values can be an array or a string.

      */
      */

-    public function put($key, $value)
+    public function put(string $key, $value): bool

     {
     {

-        $setting = $this->setting->firstOrNew([
-            'setting_key' => $key
+        $setting = $this->setting->newQuery()->firstOrNew([
+            'setting_key' => $key,

         ]);
         ]);

+        $setting->type = 'string';
+
+        if (is_array($value)) {
+            $setting->type = 'array';
+            $value = $this->formatArrayValue($value);
+        }
+

         $setting->value = $value;
         $setting->save();
         $this->clearFromCache($key);
         $setting->value = $value;
         $setting->save();
         $this->clearFromCache($key);

+

         return true;
     }
 
         return true;
     }
 

+    /**
+     * Format an array to be stored as a setting.
+     * Array setting types are expected to be a flat array of child key=>value array items.
+     * This filters out any child items that are empty.
+     */
+    protected function formatArrayValue(array $value): string
+    {
+        $values = collect($value)->values()->filter(function (array $item) {
+            return count(array_filter($item)) > 0;
+        });
+
+        return json_encode($values);
+    }
+

     /**
      * Put a user-specific setting into the database.
     /**
      * Put a user-specific setting into the database.

-     * @param \BookStack\Auth\User $user
-     * @param $key
-     * @param $value
-     * @return bool

      */
      */

-    public function putUser($user, $key, $value)
+    public function putUser(User $user, string $key, string $value): bool

     {
         if ($user->isDefault()) {
     {
         if ($user->isDefault()) {

-            return session()->put($key, $value);
+            session()->put($key, $value);
+
+            return true;

         }
         }

+

         return $this->put($this->userKey($user->id, $key), $value);
     }
 
     /**
      * Convert a setting key into a user-specific key.
         return $this->put($this->userKey($user->id, $key), $value);
     }
 
     /**
      * Convert a setting key into a user-specific key.

-     * @param $key
-     * @return string

      */
      */

-    protected function userKey($userId, $key = '')
+    protected function userKey(string $userId, string $key = ''): string

     {
         return 'user:' . $userId . ':' . $key;
     }
 
     /**
      * Removes a setting from the database.
     {
         return 'user:' . $userId . ':' . $key;
     }
 
     /**
      * Removes a setting from the database.

-     * @param $key
-     * @return bool

      */
      */

-    public function remove($key)
+    public function remove(string $key): void

     {
         $setting = $this->getSettingObjectByKey($key);
         if ($setting) {
             $setting->delete();
         }
         $this->clearFromCache($key);
     {
         $setting = $this->getSettingObjectByKey($key);
         if ($setting) {
             $setting->delete();
         }
         $this->clearFromCache($key);

-        return true;

     }
 
     /**
      * Delete settings for a given user id.
     }
 
     /**
      * Delete settings for a given user id.

-     * @param $userId
-     * @return mixed

      */
      */

-    public function deleteUserSettings($userId)
+    public function deleteUserSettings(string $userId)

     {
     {

-        return $this->setting->where('setting_key', 'like', $this->userKey($userId) . '%')->delete();
+        return $this->setting->newQuery()
+            ->where('setting_key', 'like', $this->userKey($userId) . '%')
+            ->delete();

     }
 
     /**
      * Gets a setting model from the database for the given key.
     }
 
     /**
      * Gets a setting model from the database for the given key.

-     * @param $key
-     * @return mixed

      */
      */

-    protected function getSettingObjectByKey($key)
+    protected function getSettingObjectByKey(string $key): ?Setting

     {
     {

-        return $this->setting->where('setting_key', '=', $key)->first();
+        return $this->setting->newQuery()
+            ->where('setting_key', '=', $key)->first();

     }
 }
     }
 }