webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00
Code Activity

Updated footer links to be a configurable list

Browse Source 
Made so footer link ordering, names and urls can be set.
Cleaned up some of the setting-service and added support for array
setting types, which are cleaned on entry and stored as json with a new
type indicator column on the settings table for auto-decode.
Also added testing to cover this feature.

Related to #1973 and #854
This commit is contained in:
Dan Brown
2021-01-31 00:23:15 +00:00
parent a663364223
commit 44c41e9e4d
9 changed files with 198 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
app/Settings/SettingService.php
View File

@ -1,5 +1,6 @@
<?php namespace BookStack\Settings;
use BookStack\Auth\User;
use Illuminate\Contracts\Cache\Repository as Cache;
/**
@ -9,7 +10,6 @@ use Illuminate\Contracts\Cache\Repository as Cache;
*/
class SettingService
{
protected $setting;
protected $cache;
protected $localCache = [];
@ -18,8 +18,6 @@ class SettingService
/**
* SettingService constructor.
* @param Setting $setting
* @param Cache $cache
*/
public function __construct(Setting $setting, Cache $cache)
{
@ -30,11 +28,8 @@ class SettingService
/**
* 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 = false)
{
if ($default === false) {
$default = config('setting-defaults.' . $key, false);
@ -44,7 +39,7 @@ class SettingService
return $this->localCache[$key];
}
$value = $this->getValueFromStore($key, $default);
$value = $this->getValueFromStore($key) ?? $default;
$formatted = $this->formatValue($value, $default);
$this->localCache[$key] = $formatted;
return $formatted;
@ -52,25 +47,17 @@ class SettingService
/**
* 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);
$formatted = $this->formatValue($value, $default);
return $formatted;
return $this->formatValue($value, $default);
}
/**
* 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 = false)
{
if ($user->isDefault()) {
return $this->getFromSession($key, $default);
@ -80,11 +67,8 @@ class SettingService
/**
* 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 = false)
{
return $this->getUser(user(), $key, $default);
}
@ -92,11 +76,9 @@ class SettingService
/**
* 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;
@ -109,18 +91,22 @@ class SettingService
$settingObject = $this->getSettingObjectByKey($key);
if ($settingObject !== null) {
$value = $settingObject->value;
if ($settingObject->type === 'array') {
$value = json_decode($value, true) ?? [];
}
$this->cache->forever($cacheKey, $value);
return $value;
}
return $default;
return null;
}
/**
* 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);
@ -131,17 +117,13 @@ class SettingService
/**
* 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') {
} else if ($value === 'false') {
$value = false;
}
@ -154,36 +136,29 @@ class SettingService
/**
* Checks if a setting exists.
* @param $key
* @return bool
*/
public function has($key)
public function has(string $key): bool
{
$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));
}
/**
* 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 = $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);
@ -191,62 +166,67 @@ class SettingService
}
/**
* Put a user-specific setting into the database.
* @param \BookStack\Auth\User $user
* @param $key
* @param $value
* @return bool
* 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.
*/
public function putUser($user, $key, $value)
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.
*/
public function putUser(User $user, string $key, string $value): bool
{
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.
* @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.
* @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);
return true;
}
/**
* 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.
* @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();
}
}