bitPickups/friendica_2020-09-1_sharedHosting
1
0
Fork 0
Code Pull requests Activity

Restructure (P)Config to follow new paradigm

Browse source
This commit is contained in:
Philipp Holzer 2021-10-23 11:29:16 +02:00
commit ab83d0dd27
Signed by: nupplaPhil
GPG key ID: 24A7501396EB5432
49 changed files with 368 additions and 331 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/Core/PConfig/Cache.php → src/Core/PConfig/Cache/Cache.php
View file

@ -19,7 +19,7 @@
*
*/
namespace Friendica\Core\PConfig;
namespace Friendica\Core\PConfig\Cache;
use ParagonIE\HiddenString\HiddenString;

48
src/Core/PConfig/Factory/PConfigFactory.php Normal file
View file

@ -0,0 +1,48 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 Friendica\Core\PConfig\Factory;
use Friendica\Core\Config\Cache\Cache;
use Friendica\Core\PConfig\IPConfig;
use Friendica\Core\PConfig\Model\PConfig as PConfigModel;
use Friendica\Core\PConfig\Type;
class PConfigFactory
{
/**
* @param Cache $configCache The config cache
* @param \Friendica\Core\PConfig\Cache\Cache $pConfigCache The personal config cache
* @param PConfigModel $configModel The configuration model
*
* @return IPConfig
*/
public function create(Cache $configCache, \Friendica\Core\PConfig\Cache\Cache $pConfigCache, PConfigModel $configModel)
{
if ($configCache->get('system', 'config_adapter') === 'preload') {
$configuration = new Type\PreloadPConfig($pConfigCache, $configModel);
} else {
$configuration = new Type\JitPConfig($pConfigCache, $configModel);
}
return $configuration;
}
}

4
src/Core/PConfig/IPConfig.php
View file

@ -21,6 +21,8 @@
namespace Friendica\Core\PConfig;
use Friendica\Core\Config\Cache\Cache;
/**
* Interface for accessing user specific configurations
*/
@ -95,7 +97,7 @@ interface IPConfig
/**
* Returns the Config Cache
*
* @return Cache
* @return \Friendica\Core\PConfig\Cache\Cache
*/
function getCache();
}

177
src/Core/PConfig/Model/PConfig.php Normal file
View file

@ -0,0 +1,177 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 Friendica\Core\PConfig\Model;
use Friendica\Core\Config\Model\DbaUtils;
use Friendica\Database\Database;
/**
* The Config model backend for users, which is using the general DB-model backend for user-configs
*/
class PConfig
{
/** @var Database */
protected $dba;
/**
* @param Database $dba The database connection of this model
*/
public function __construct(Database $dba)
{
$this->dba = $dba;
}
/**
* Checks if the model is currently connected
*
* @return bool
*/
public function isConnected()
{
return $this->dba->isConnected();
}
/**
* Loads all configuration values and returns the loaded category as an array.
*
* @param int $uid The id of the user to load
* @param string|null $cat The category of the configuration values to load
*
* @return array The config array
*
* @throws \Exception In case DB calls are invalid
*/
public function load(int $uid, string $cat = null)
{
$return = [];
if (empty($cat)) {
$configs = $this->dba->select('pconfig', ['cat', 'v', 'k'], ['uid' => $uid]);
} else {
$configs = $this->dba->select('pconfig', ['cat', 'v', 'k'], ['cat' => $cat, 'uid' => $uid]);
}
while ($config = $this->dba->fetch($configs)) {
$key = $config['k'];
$value = DbaUtils::toConfigValue($config['v']);
// just save it in case it is set
if (isset($value)) {
$return[$config['cat']][$key] = $value;
}
}
$this->dba->close($configs);
return $return;
}
/**
* Get a particular user config variable out of the DB with the
* given category name ($cat) and a key ($key).
*
* Note: Boolean variables are defined as 0/1 in the database
*
* @param int $uid The id of the user to load
* @param string $cat The category of the configuration value
* @param string $key The configuration key to query
*
* @return array|string|null Stored value or null if it does not exist
*
* @throws \Exception In case DB calls are invalid
*/
public function get(int $uid, string $cat, string $key)
{
if (!$this->isConnected()) {
return null;
}
$config = $this->dba->selectFirst('pconfig', ['v'], ['uid' => $uid, 'cat' => $cat, 'k' => $key]);
if ($this->dba->isResult($config)) {
$value = DbaUtils::toConfigValue($config['v']);
// just return it in case it is set
if (isset($value)) {
return $value;
}
}
return null;
}
/**
* Stores a config value ($value) in the category ($cat) under the key ($key) for a
* given user ($uid).
*
* Note: Please do not store booleans - convert to 0/1 integer values!
*
* @param int $uid The id of the user to load
* @param string $cat The category of the configuration value
* @param string $key The configuration key to set
* @param mixed $value The value to store
*
* @return bool Operation success
*
* @throws \Exception In case DB calls are invalid
*/
public function set(int $uid, string $cat, string $key, $value)
{
if (!$this->isConnected()) {
return false;
}
// We store our setting values in a string variable.
// So we have to do the conversion here so that the compare below works.
// The exception are array values.
$compare_value = (!is_array($value) ? (string)$value : $value);
$stored_value = $this->get($uid, $cat, $key);
if (isset($stored_value) && ($stored_value === $compare_value)) {
return true;
}
$dbvalue = DbaUtils::toDbValue($value);
$result = $this->dba->update('pconfig', ['v' => $dbvalue], ['uid' => $uid, 'cat' => $cat, 'k' => $key], true);
return $result;
}
/**
* Removes the configured value of the given user.
*
* @param int $uid The id of the user to load
* @param string $cat The category of the configuration value
* @param string $key The configuration key to delete
*
* @return bool Operation success
*
* @throws \Exception In case DB calls are invalid
*/
public function delete(int $uid, string $cat, string $key)
{
if (!$this->isConnected()) {
return false;
}
return $this->dba->delete('pconfig', ['uid' => $uid, 'cat' => $cat, 'k' => $key]);
}
}

66
src/Core/PConfig/Type/BasePConfig.php Normal file
View file

@ -0,0 +1,66 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 Friendica\Core\PConfig\Type;
use Friendica\Core\PConfig\Cache\Cache;
use Friendica\Core\PConfig\IPConfig;
use Friendica\Model;
/**
* This class is responsible for the user-specific configuration values in Friendica
* The values are set through the Config-DB-Table (per Config-DB-model @see Model\Config\PConfig)
*
* The configuration cache (@see Cache\PConfigCache) is used for temporary caching of database calls. This will
* increase the performance.
*/
abstract class BasePConfig implements IPConfig
{
/**
* @var \Friendica\Core\PConfig\Cache\Cache
*/
protected $configCache;
/**
* @var \Friendica\Core\PConfig\Model\PConfig
*/
protected $configModel;
/**
* @param \Friendica\Core\PConfig\Cache\Cache $configCache The configuration cache
* @param \Friendica\Core\PConfig\Model\PConfig $configModel The configuration model
*/
public function __construct(Cache $configCache, \Friendica\Core\PConfig\Model\PConfig $configModel)
{
$this->configCache = $configCache;
$this->configModel = $configModel;
}
/**
* Returns the Config Cache
*
* @return \Friendica\Core\PConfig\Cache\Cache
*/
public function getCache()
{
return $this->configCache;
}
}

10
src/Core/PConfig/JitPConfig.php → src/Core/PConfig/Type/JitPConfig.php
View file

@ -19,9 +19,9 @@
*
*/
namespace Friendica\Core\PConfig;
namespace Friendica\Core\PConfig\Type;
use Friendica\Core\BasePConfig;
use Friendica\Core\PConfig\Cache\Cache;
use Friendica\Model;
/**
@ -39,10 +39,10 @@ class JitPConfig extends BasePConfig
private $db_loaded;
/**
* @param Cache $configCache The configuration cache
* @param Model\Config\PConfig $configModel The configuration model
* @param Cache $configCache The configuration cache
* @param \Friendica\Core\PConfig\Model\PConfig $configModel The configuration model
*/
public function __construct(Cache $configCache, Model\Config\PConfig $configModel)
public function __construct(Cache $configCache, \Friendica\Core\PConfig\Model\PConfig $configModel)
{
parent::__construct($configCache, $configModel);
$this->db_loaded = [];

10
src/Core/PConfig/PreloadPConfig.php → src/Core/PConfig/Type/PreloadPConfig.php
View file

@ -19,9 +19,9 @@
*
*/
namespace Friendica\Core\PConfig;
namespace Friendica\Core\PConfig\Type;
use Friendica\Core\BasePConfig;
use Friendica\Core\PConfig\Cache\Cache;
use Friendica\Model;
/**
@ -36,10 +36,10 @@ class PreloadPConfig extends BasePConfig
private $config_loaded;
/**
* @param Cache $configCache The configuration cache
* @param Model\Config\PConfig $configModel The configuration model
* @param \Friendica\Core\PConfig\Cache\Cache $configCache The configuration cache
* @param \Friendica\Core\PConfig\Model\PConfig $configModel The configuration model
*/
public function __construct(Cache $configCache, Model\Config\PConfig $configModel)
public function __construct(Cache $configCache, \Friendica\Core\PConfig\Model\PConfig $configModel)
{
parent::__construct($configCache, $configModel);
$this->config_loaded = [];