Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-27 00:30:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge remote-tracking branch 'upstream/develop' into c2s-post

Browse source
This commit is contained in:
Michael 2023-02-13 19:20:18 +00:00
commit 7b871f3ecd
41 changed files with 678 additions and 984 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/Core/Config/Capability/IManageConfigValues.php
View file

@ -31,7 +31,7 @@ use Friendica\Core\Config\ValueObject\Cache;
interface IManageConfigValues
{
/**
* Reloads all configuration values (from filesystem and environment variables)
* Reloads all configuration values from the persistence layer
*
* All configuration values of the system are stored in the cache.
*

139
src/Core/Config/Model/Config.php
View file

@ -1,139 +0,0 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, 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\Config\Model;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Config\Capability\ISetConfigValuesTransactionally;
use Friendica\Core\Config\Exception\ConfigFileException;
use Friendica\Core\Config\Exception\ConfigPersistenceException;
use Friendica\Core\Config\Util\ConfigFileManager;
use Friendica\Core\Config\ValueObject\Cache;
/**
* Configuration model, which manages the whole system configuration
*/
class Config implements IManageConfigValues
{
/** @var Cache */
protected $configCache;
/** @var ConfigFileManager */
protected $configFileManager;
/**
* @param ConfigFileManager $configFileManager The configuration file manager to save back configs
* @param Cache $configCache The configuration cache (based on the config-files)
*/
public function __construct(ConfigFileManager $configFileManager, Cache $configCache)
{
$this->configFileManager = $configFileManager;
$this->configCache = $configCache;
}
/**
* Load all configuration values from a given cache and saves it back in the configuration node store
* @see ConfigFileManager::CONFIG_DATA_FILE
*
* All configuration values of the system are stored in the cache.
*
* @param Cache $cache a new cache
*
* @return void
*
* @throws ConfigPersistenceException In case the persistence layer throws errors
*/
public function setCacheAndSave(Cache $cache)
{
$this->configCache = $cache;
$this->save();
}
/**
* {@inheritDoc}
*/
public function getCache(): Cache
{
return $this->configCache;
}
/** {@inheritDoc} */
public function beginTransaction(): ISetConfigValuesTransactionally
{
return new ConfigTransaction($this);
}
/**
* Saves the current Configuration back into the data config.
* @see ConfigFileManager::CONFIG_DATA_FILE
*/
protected function save()
{
try {
$this->configFileManager->saveData($this->configCache);
// reload after the save to possible reload default values of lower source-priorities again
$this->reload();
} catch (ConfigFileException $e) {
throw new ConfigPersistenceException('Cannot save config', $e);
}
}
/** {@inheritDoc} */
public function reload()
{
$configCache = new Cache();
try {
$this->configFileManager->setupCache($configCache);
} catch (ConfigFileException $e) {
throw new ConfigPersistenceException('Cannot reload config', $e);
}
$this->configCache = $configCache;
}
/** {@inheritDoc} */
public function get(string $cat, string $key = null, $default_value = null)
{
return $this->configCache->get($cat, $key) ?? $default_value;
}
/** {@inheritDoc} */
public function set(string $cat, string $key, $value): bool
{
if ($this->configCache->set($cat, $key, $value, Cache::SOURCE_DATA)) {
$this->save();
return true;
} else {
return false;
}
}
/** {@inheritDoc} */
public function delete(string $cat, string $key): bool
{
if ($this->configCache->delete($cat, $key)) {
$this->save();
return true;
} else {
return false;
}
}
}

20
src/Core/Config/Model/ConfigTransaction.php
View file

@ -34,20 +34,23 @@ class ConfigTransaction implements ISetConfigValuesTransactionally
/** @var IManageConfigValues */
protected $config;
/** @var Cache */
protected $cache;
protected $setCache;
/** @var Cache */
protected $delCache;
/** @var bool field to check if something is to save */
protected $changedConfig = false;
public function __construct(IManageConfigValues $config)
public function __construct(DatabaseConfig $config)
{
$this->config = $config;
$this->cache = clone $config->getCache();
$this->config = $config;
$this->setCache = new Cache();
$this->delCache = new Cache();
}
/** {@inheritDoc} */
public function set(string $cat, string $key, $value): ISetConfigValuesTransactionally
{
$this->cache->set($cat, $key, $value, Cache::SOURCE_DATA);
$this->setCache->set($cat, $key, $value, Cache::SOURCE_DATA);
$this->changedConfig = true;
return $this;
@ -57,7 +60,7 @@ class ConfigTransaction implements ISetConfigValuesTransactionally
/** {@inheritDoc} */
public function delete(string $cat, string $key): ISetConfigValuesTransactionally
{
$this->cache->delete($cat, $key);
$this->delCache->set($cat, $key, true, Cache::SOURCE_DATA);
$this->changedConfig = true;
return $this;
@ -72,8 +75,9 @@ class ConfigTransaction implements ISetConfigValuesTransactionally
}
try {
$this->config->setCacheAndSave($this->cache);
$this->cache = clone $this->config->getCache();
$this->config->setAndSave($this->setCache, $this->delCache);
$this->setCache = new Cache();
$this->delCache = new Cache();
} catch (\Exception $e) {
throw new ConfigPersistenceException('Cannot save config', $e);
}

110
src/Core/Config/Model/DatabaseConfig.php Normal file
View file

@ -0,0 +1,110 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, 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\Config\Model;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Config\Capability\ISetConfigValuesTransactionally;
use Friendica\Core\Config\Util\SerializeUtil;
use Friendica\Core\Config\ValueObject\Cache;
use Friendica\Database\Database;
/**
* Complete system configuration model, bound with the database
*/
class DatabaseConfig implements IManageConfigValues
{
/** @var Database */
protected $database;
/** @var Cache */
protected $cache;
public function __construct(Database $database, Cache $cache)
{
$this->database = $database;
$this->cache = $cache;
$this->reload();
}
/** {@inheritDoc} */
public function reload()
{
$config = $this->database->selectToArray('config');
foreach ($config as $entry) {
$this->cache->set($entry['cat'], $entry['k'], SerializeUtil::maybeUnserialize($entry['v']), Cache::SOURCE_DATA);
}
}
public function setAndSave(Cache $setCache, Cache $delCache): bool
{
$this->database->transaction();
foreach ($setCache->getAll() as $category => $data) {
foreach ($data as $key => $value) {
$this->cache->set($category, $key, $value, Cache::SOURCE_DATA);
$this->database->insert('config', ['cat' => $category, 'k' => $key, 'v' => serialize($value)], Database::INSERT_UPDATE);
}
}
foreach ($delCache->getAll() as $category => $keys) {
foreach ($keys as $key => $value) {
$this->cache->delete($category, $key);
$this->database->delete('config', ['cat' => $category, 'k' => $key]);
}
}
return $this->database->commit();
}
/** {@inheritDoc} */
public function get(string $cat, string $key = null, $default_value = null)
{
return $this->cache->get($cat, $key) ?? $default_value;
}
/** {@inheritDoc} */
public function set(string $cat, string $key, $value): bool
{
$this->cache->set($cat, $key, $value, Cache::SOURCE_DATA);
return $this->database->insert('config', ['cat' => $cat, 'k' => $key, 'v' => serialize($value)], Database::INSERT_UPDATE);
}
/** {@inheritDoc} */
public function beginTransaction(): ISetConfigValuesTransactionally
{
return new ConfigTransaction($this);
}
/** {@inheritDoc} */
public function delete(string $cat, string $key): bool
{
$this->cache->delete($cat, $key);
return $this->database->delete('config', ['cat' => $cat, 'k' => $key]);
}
/** {@inheritDoc} */
public function getCache(): Cache
{
return $this->cache;
}
}

82
src/Core/Config/Model/ReadOnlyFileConfig.php Normal file
View file

@ -0,0 +1,82 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, 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\Config\Model;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Config\Capability\ISetConfigValuesTransactionally;
use Friendica\Core\Config\Exception\ConfigPersistenceException;
use Friendica\Core\Config\ValueObject\Cache;
/**
* Creates a basic, readonly model for the file-based configuration
*/
class ReadOnlyFileConfig implements IManageConfigValues
{
/** @var Cache */
protected $configCache;
/**
* @param Cache $configCache The configuration cache (based on the config-files)
*/
public function __construct(Cache $configCache)
{
$this->configCache = $configCache;
}
/**
* {@inheritDoc}
*/
public function getCache(): Cache
{
return $this->configCache;
}
/** {@inheritDoc} */
public function beginTransaction(): ISetConfigValuesTransactionally
{
throw new ConfigPersistenceException('beginTransaction not allowed.');
}
/** {@inheritDoc} */
public function reload()
{
throw new ConfigPersistenceException('reload not allowed.');
}
/** {@inheritDoc} */
public function get(string $cat, string $key = null, $default_value = null)
{
return $this->configCache->get($cat, $key) ?? $default_value;
}
/** {@inheritDoc} */
public function set(string $cat, string $key, $value): bool
{
throw new ConfigPersistenceException('set not allowed.');
}
/** {@inheritDoc} */
public function delete(string $cat, string $key): bool
{
throw new ConfigPersistenceException('Save not allowed');
}
}

164
src/Core/Config/Util/ConfigFileManager.php
View file

@ -111,9 +111,6 @@ class ConfigFileManager
// Now load every other config you find inside the 'config/' directory
$this->loadCoreConfig($configCache);
// Now load the node.config.php file with the node specific config values (based on admin gui/console actions)
$this->loadDataConfig($configCache);
$configCache->load($this->loadEnvConfig(), Cache::SOURCE_ENV);
// In case of install mode, add the found basepath (because there isn't a basepath set yet
@ -166,167 +163,6 @@ class ConfigFileManager
}
}
/**
* Tries to load the data config file with the overridden data
*
* @param Cache $configCache The Config cache
*
* @throws ConfigFileException In case the config file isn't loadable
*/
private function loadDataConfig(Cache $configCache)
{
$filename = $this->configDir . '/' . self::CONFIG_DATA_FILE;
if (file_exists($filename) && (filesize($filename) > 0)) {
// The fallback empty return content
$content = '<?php return [];';
/**
* This code-block creates a readonly node.config.php content stream (fopen() with "r")
* The stream is locked shared (LOCK_SH), so not exclusively, but the OS knows that there's a lock
*
* Any exclusive locking (LOCK_EX) would need to wait until all LOCK_SHs are unlocked
*/
if (($configStream = @fopen($filename, 'r')) === false) {
throw new ConfigFileException(sprintf('Cannot open file "%s" in mode r', $filename));
}
try {
if (flock($configStream, LOCK_SH)) {
clearstatcache(true, $filename);
if (($filesize = filesize($filename)) === 0) {
return;
}
$content = fread($configStream, $filesize);
if (!$content) {
throw new ConfigFileException(sprintf('Couldn\'t read file %s', $filename));
}
}
} finally {
// unlock and close the stream for every circumstances
flock($configStream, LOCK_UN);
fclose($configStream);
}
/**
* Evaluate the content string as PHP code
*
* @see https://www.php.net/manual/en/function.eval.php
*
* @note
* To leave the PHP mode, we have to use the appropriate PHP tags '?>' as prefix.
*/
$dataArray = eval('?>' . $content);
if (is_array($dataArray)) {
$configCache->load($dataArray, Cache::SOURCE_DATA);
}
}
}
/**
* Checks, if the node.config.php is writable
*
* @return bool
*/
public function dataIsWritable(): bool
{
$filename = $this->configDir . '/' . self::CONFIG_DATA_FILE;
if (file_exists($filename)) {
return is_writable($filename);
} else {
return is_writable($this->configDir);
}
}
/**
* Saves overridden config entries back into the data.config.php
*
* @param Cache $configCache The config cache
*
* @throws ConfigFileException In case the config file isn't writeable or the data is invalid
*/
public function saveData(Cache $configCache)
{
$filename = $this->configDir . '/' . self::CONFIG_DATA_FILE;
if (file_exists($filename)) {
$fileExists = true;
} else {
$fileExists = false;
}
/**
* Creates a read-write stream
*
* @see https://www.php.net/manual/en/function.fopen.php
* @note Open the file for reading and writing. If the file does not exist, it is created.
* If it exists, it is neither truncated (as opposed to 'w'), nor the call to this function fails
* (as is the case with 'x'). The file pointer is positioned on the beginning of the file.
*
*/
if (($configStream = @fopen($filename, 'c+')) === false) {
throw new ConfigFileException(sprintf('Cannot open file "%s" in mode c+', $filename));
}
try {
// We do want an exclusive lock, so we wait until every LOCK_SH (config reading) is unlocked
if (flock($configStream, LOCK_EX)) {
/**
* If the file exists, we read the whole file again to avoid a race condition with concurrent threads that could have modified the file between the first config read of this thread and now
* Since we're currently exclusive locked, no other process can now change the config again
*/
if ($fileExists) {
// When reading the config file too fast, we get a wrong filesize, "clearstatcache" prevents that
clearstatcache(true, $filename);
$content = fread($configStream, filesize($filename));
if (!$content) {
throw new ConfigFileException(sprintf('Cannot read file %s', $filename));
}
// Event truncating the whole content wouldn't automatically rewind the stream,
// so we need to do it manually
rewind($configStream);
$dataArray = eval('?>' . $content);
// Merge the new content into the existing file based config cache and use it
// as the new config cache
if (is_array($dataArray)) {
$fileConfigCache = new Cache();
$fileConfigCache->load($dataArray, Cache::SOURCE_DATA);
$configCache = $fileConfigCache->merge($configCache);
}
}
// Only SOURCE_DATA is wanted, the rest isn't part of the node.config.php file
$data = $configCache->getDataBySource(Cache::SOURCE_DATA);
$encodedData = ConfigFileTransformer::encode($data);
if (!$encodedData) {
throw new ConfigFileException('config source cannot get encoded');
}
// Once again to avoid wrong, implicit "filesize" calls during the fwrite() or ftruncate() call
clearstatcache(true, $filename);
if (!ftruncate($configStream, 0) ||
!fwrite($configStream, $encodedData) ||
!fflush($configStream)) {
throw new ConfigFileException(sprintf('Cannot modify locked file %s', $filename));
}
}
} finally {
// unlock and close the stream for every circumstances
flock($configStream, LOCK_UN);
fclose($configStream);
}
}
/**
* Tries to load the specified addon-configuration and returns the config array.
*

237
src/Core/Config/Util/ConfigFileTransformer.php
View file

@ -1,237 +0,0 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, 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\Config\Util;
/**
* Util to transform back the config array into a string
*/
class ConfigFileTransformer
{
/**
* This method takes an array of config values and applies some standard rules for formatting on it
*
* Beware that the applied rules follow some basic formatting principles for node.config.php
* and doesn't support any custom formatting rules.
*
* f.e. associative array and list formatting are very complex with newlines and indentations, thus there are
* three hardcoded types of formatting for them.
*
* a negative example, what's NOT working:
* key => [ value1, [inner_value1, inner_value2], value2]
* Since this isn't necessary for config values, there's no further logic handling such complex-list-in-list scenarios
*
* @param array $data A full config array
*
* @return string The config stream, which can be saved
*/
public static function encode(array $data): string
{
// Add the typical header values
$dataString = '<?php' . PHP_EOL . PHP_EOL;
$dataString .= 'return ';
$dataString .= static::extractArray($data);
// the last array line, close it with a semicolon
$dataString .= ";" . PHP_EOL;
return $dataString;
}
/**
* Extracts an inner config array.
* Either as an associative array or as a list
*
* @param array $config The config array which should get extracted
* @param int $level The current level of recursion (necessary for tab-indentation calculation)
* @param bool $inList If true, the current array resides inside another list. Different rules may be applicable
*
* @return string The config string
*/
protected static function extractArray(array $config, int $level = 0, bool $inList = false): string
{
if (array_values($config) === $config) {
return self::extractList($config, $level, $inList);
} else {
return self::extractAssociativeArray($config, $level, $inList);
}
}
/**
* Extracts a key-value array and save it into a string
* output:
* [
* 'key' => value,
* 'key' => value,
* ...
* ]
*
* @param array $config The associative/key-value array
* @param int $level The current level of recursion (necessary for tab-indentation calculation)
* @param bool $inList If true, the current array resides inside another list. Different rules may be applicable
*
* @return string The config string
*/
protected static function extractAssociativeArray(array $config, int $level = 0, bool $inList = false): string
{
$string = '';
// Because we're in a list, we have to add a line-break first
if ($inList) {
$string .= PHP_EOL . str_repeat("\t", $level);
}
// Add a typical Line break for a taxative list of key-value pairs
$string .= '[' . PHP_EOL;
foreach ($config as $configKey => $configValue) {
$string .= str_repeat("\t", $level + 1) .
"'$configKey' => " .
static::transformConfigValue($configValue, $level) .
',' . PHP_EOL;
}
$string .= str_repeat("\t", $level) . ']';
return $string;
}
/**
* Extracts a list and save it into a string
* output1 - simple:
* [ value, value, value ]
*
* output2 - complex:
* [
* [ value, value, value ],
* value,
* [
* key => value,
* key => value,
* ],
* ]
*
* @param array $config The list
* @param int $level The current level of recursion (necessary for tab-indentation calculation)
* @param bool $inList If true, the current array resides inside another list. Different rules may be applicable
*
* @return string The config string
*/
protected static function extractList(array $config, int $level = 0, bool $inList = false): string
{
$string = '[';
$countConfigValues = count($config);
// multiline defines, if each entry uses a new line
$multiline = false;
// Search if any value is an array, because then other formatting rules are applicable
foreach ($config as $item) {
if (is_array($item)) {
$multiline = true;
break;
}
}
for ($i = 0; $i < $countConfigValues; $i++) {
$isArray = is_array($config[$i]);
/**
* In case this is an array in an array, directly extract this array again and continue
* Skip any other logic since this isn't applicable for an array in an array
*/
if ($isArray) {
$string .= PHP_EOL . str_repeat("\t", $level + 1);
$string .= static::extractArray($config[$i], $level + 1, $inList) . ',';
continue;
}
if ($multiline) {
$string .= PHP_EOL . str_repeat("\t", $level + 1);
}
$string .= static::transformConfigValue($config[$i], $level, true);
// add trailing commas or whitespaces for certain config entries
if (($i < ($countConfigValues - 1))) {
$string .= ',';
if (!$multiline) {
$string .= ' ';
}
}
}
// Add a new line for the last bracket as well
if ($multiline) {
$string .= PHP_EOL . str_repeat("\t", $level);
}
$string .= ']';
return $string;
}
/**
* Transforms one config value and returns the corresponding text-representation
*
* @param mixed $value Any value to transform
* @param int $level The current level of recursion (necessary for tab-indentation calculation)
* @param bool $inList If true, the current array resides inside another list. Different rules may be applicable
*
* @return string
*/
protected static function transformConfigValue($value, int $level = 0, bool $inList = false): string
{
switch (gettype($value)) {
case "boolean":
return ($value ? 'true' : 'false');
case "integer":
case "double":
return $value;
case "string":
return sprintf('\'%s\'', addcslashes($value, '\'\\'));
case "array":
return static::extractArray($value, ++$level, $inList);
case "NULL":
return "null";
case "object":
if (method_exists($value, '__toString')) {
return sprintf('\'%s\'', $value);
} elseif ($value instanceof \Serializable) {
try {
return $value->serialize();
} catch (\Exception $e) {
throw new \InvalidArgumentException(sprintf('Cannot serialize %s.', gettype($value)), $e);
}
} else {
throw new \InvalidArgumentException(sprintf('%s is an object without stringify.', gettype($value)));
}
case "resource":
case "resource (closed)":
throw new \InvalidArgumentException(sprintf('%s in configs are not supported yet.', gettype($value)));
case "unknown type":
throw new \InvalidArgumentException(sprintf('%s is an unknown value', $value));
default:
throw new \InvalidArgumentException(sprintf('%s is currently unsupported', $value));
}
}
}

114
src/Core/Config/Util/SerializeUtil.php Normal file
View file

@ -0,0 +1,114 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, 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\Config\Util;
/**
* Serialize utils
*
* Retrieved from https://github.com/WordPress/wordpress-develop/blob/6.1/src/wp-includes/functions.php
*/
class SerializeUtil
{
public static function maybeUnserialize($value)
{
if (static::isSerialized($value)) {
return @unserialize(trim($value));
}
return $value;
}
/**
* Checks value to find if it was serialized.
*
* If $data is not a string, then returned value will always be false.
* Serialized data is always a string.
*
* @param mixed $data Value to check to see if was serialized.
* @param bool $strict Optional. Whether to be strict about the end of the string. Default true.
*
* @return bool False if not serialized and true if it was.
* @since 6.1.0 Added Enum support.
*
* @since 2.0.5
*/
public static function isSerialized($data, bool $strict = true): bool
{
// If it isn't a string, it isn't serialized.
if (!is_string($data)) {
return false;
}
$data = trim($data);
if ('N;' === $data) {
return true;
}
if (strlen($data) < 4) {
return false;
}
if (':' !== $data[1]) {
return false;
}
if ($strict) {
$lastc = substr($data, -1);
if (';' !== $lastc && '}' !== $lastc) {
return false;
}
} else {
$semicolon = strpos($data, ';');
$brace = strpos($data, '}');
// Either ; or } must exist.
if (false === $semicolon && false === $brace) {
return false;
}
// But neither must be in the first X characters.
if (false !== $semicolon && $semicolon < 3) {
return false;
}
if (false !== $brace && $brace < 4) {
return false;
}
}
$token = $data[0];
switch ($token) {
case 's':
if ($strict) {
if ('"' !== substr($data, -2, 1)) {
return false;
}
} elseif (false === strpos($data, '"')) {
return false;
}
// Or else fall through.
// no break
case 'a':
case 'O':
case 'E':
return (bool)preg_match("/^{$token}:[0-9]+:/s", $data);
case 'b':
case 'i':
case 'd':
$end = $strict ? '$' : '';
return (bool)preg_match("/^{$token}:[0-9.E+-]+;$end/", $data);
}
return false;
}
}

2
src/Core/Logger/Type/StreamLogger.php
View file

@ -92,7 +92,7 @@ class StreamLogger extends AbstractLogger implements IAmAStrategy
$this->fileSystem = $fileSystem;
$stream = $this->logfile ?? $config->get('system', 'logfile');
if ((file_exists($stream) && !is_writable($stream)) || is_writable(basename($stream))) {
if ((@file_exists($stream) && !@is_writable($stream)) && !@is_writable(basename($stream))) {
throw new LoggerArgumentException(sprintf('%s is not a valid logfile', $stream));
}

23
src/Core/Update.php
View file

@ -129,15 +129,26 @@ class Update
DI::lock()->release('dbupdate', true);
}
if (!DBStructure::existsTable('config')) {
DBA::e(<<<EOF
CREATE TABLE IF NOT EXISTS `config` (
`id` int unsigned NOT NULL auto_increment COMMENT '',
`cat` varbinary(50) NOT NULL DEFAULT '' COMMENT 'The category of the entry',
`k` varbinary(50) NOT NULL DEFAULT '' COMMENT 'The key of the entry',
`v` mediumtext COMMENT '',
PRIMARY KEY(`id`),
UNIQUE INDEX `cat_k` (`cat`,`k`)
) DEFAULT COLLATE utf8mb4_general_ci COMMENT='main configuration storage';
EOF
);
}
$build = DI::config()->get('system', 'build');
if (empty($build)) {
// legacy option - check if there's something in the Config table
if (DBStructure::existsTable('config')) {
$dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
if (!empty($dbConfig)) {
$build = $dbConfig['v'];
}
$dbConfig = DBA::selectFirst('config', ['v'], ['cat' => 'system', 'k' => 'build']);
if (!empty($dbConfig)) {
$build = $dbConfig['v'];
}
if (empty($build) || ($build > DB_UPDATE_VERSION)) {

27
src/DI.php
View file

@ -37,9 +37,34 @@ abstract class DI
/** @var Dice */
private static $dice;
public static function init(Dice $dice)
/**
* Initialize the singleton DI container with the Dice instance
*
* @param Dice $dice The Dice instance
* @param bool $disableDepByHand If true, the database dependencies aren't set, thus any occurrence of logging or
* profiling in database methods would lead to an error. This flag is for testing only.
*
* @return void
*/
public static function init(Dice $dice, bool $disableDepByHand = false)
{
self::$dice = $dice;
if (!$disableDepByHand) {
self::setCompositeRootDependencyByHand();
}
}
/**
* I HATE this method, but everything else needs refactoring at the database itself
* Set the database dependencies manually, because of current, circular dependencies between the database and the config table
*
* @todo Instead of this madness, split the database in a core driver-dependent (mysql, mariadb, postgresql, ..) part without any other dependency unlike credentials and in the full-featured, driver-independent database class with all dependencies
*/
public static function setCompositeRootDependencyByHand()
{
$database = static::dba();
$database->setDependency(static::config(), static::profiler(), static::logger());
}
/**

2
src/Database/DBStructure.php
View file

@ -74,7 +74,7 @@ class DBStructure
$old_tables = ['fserver', 'gcign', 'gcontact', 'gcontact-relation', 'gfollower' ,'glink', 'item-delivery-data',
'item-activity', 'item-content', 'item_id', 'participation', 'poll', 'poll_result', 'queue', 'retriever_rule',
'deliverq', 'dsprphotoq', 'ffinder', 'sign', 'spam', 'term', 'user-item', 'thread', 'item', 'challenge',
'auth_codes', 'tokens', 'clients', 'profile_check', 'host', 'conversation', 'fcontact', 'config', 'addon'];
'auth_codes', 'tokens', 'clients', 'profile_check', 'host', 'conversation', 'fcontact', 'addon'];
$tables = DBA::selectToArray('INFORMATION_SCHEMA.TABLES', ['TABLE_NAME'],
['TABLE_SCHEMA' => DBA::databaseName(), 'TABLE_TYPE' => 'BASE TABLE']);

31
src/Database/Database.php
View file

@ -36,6 +36,7 @@ use PDO;
use PDOException;
use PDOStatement;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
* This class is for the low level database stuff that does driver specific things.
@ -54,15 +55,15 @@ class Database
/**
* @var IManageConfigValues
*/
protected $config;
protected $config = null;
/**
* @var Profiler
*/
protected $profiler;
protected $profiler = null;
/**
* @var LoggerInterface
*/
protected $logger;
protected $logger = null;
protected $server_info = '';
/** @var PDO|mysqli */
protected $connection;
@ -80,18 +81,36 @@ class Database
/** @var ViewDefinition */
protected $viewDefinition;
public function __construct(IManageConfigValues $config, Profiler $profiler, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition, LoggerInterface $logger)
public function __construct(IManageConfigValues $config, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
{
// We are storing these values for being able to perform a reconnect
$this->config = $config;
$this->profiler = $profiler;
$this->dbaDefinition = $dbaDefinition;
$this->viewDefinition = $viewDefinition;
$this->logger = $logger;
// Use dummy values - necessary for the first factory call of the logger itself
$this->logger = new NullLogger();
$this->profiler = new Profiler($config);
$this->connect();
}
/**
* @param IManageConfigValues $config
* @param Profiler $profiler
* @param LoggerInterface $logger
*
* @return void
*
* @todo Make this method obsolet - use a clean pattern instead ...
*/
public function setDependency(IManageConfigValues $config, Profiler $profiler, LoggerInterface $logger)
{
$this->logger = $logger;
$this->profiler = $profiler;
$this->config = $config;
}
/**
* Tries to connect to database
*

4
src/Module/Admin/Summary.php
View file

@ -114,10 +114,6 @@ class Summary extends BaseAdmin
$warningtext[] = DI::l10n()->t('Friendica\'s configuration now is stored in config/local.config.php, please copy config/local-sample.config.php and move your config from <code>config/local.ini.php</code>. See <a href="%s">the Config help page</a> for help with the transition.', DI::baseUrl()->get() . '/help/Config');
}
if (!DI::configFileManager()->dataIsWritable()) {
$warningtext[] = DI::l10n()->t('Friendica\'s configuration store "%s" isn\'t writable. Until then database updates won\'t be applied automatically, admin settings and console configuration changes won\'t be saved.', ConfigFileManager::CONFIG_DATA_FILE);
}
// Check server vitality
if (!self::checkSelfHostMeta()) {
$well_known = DI::baseUrl()->get() . Probe::HOST_META;

10
src/Network/HTTPClient/Client/HttpClient.php
View file

@ -76,7 +76,7 @@ class HttpClient implements ICanSendHttpRequests
if(!filter_var($host, FILTER_VALIDATE_IP) && !@dns_get_record($host . '.', DNS_A + DNS_AAAA) && !gethostbyname($host)) {
$this->logger->debug('URL cannot be resolved.', ['url' => $url, 'callstack' => System::callstack(20)]);
$this->profiler->stopRecording();
return CurlResult::createErrorCurl($url);
return CurlResult::createErrorCurl($this->logger, $url);
}
if (Network::isLocalLink($url)) {
@ -86,7 +86,7 @@ class HttpClient implements ICanSendHttpRequests
if (strlen($url) > 1000) {
$this->logger->debug('URL is longer than 1000 characters.', ['url' => $url, 'callstack' => System::callstack(20)]);
$this->profiler->stopRecording();
return CurlResult::createErrorCurl(substr($url, 0, 200));
return CurlResult::createErrorCurl($this->logger, substr($url, 0, 200));
}
$parts2 = [];
@ -105,7 +105,7 @@ class HttpClient implements ICanSendHttpRequests
if (Network::isUrlBlocked($url)) {
$this->logger->info('Domain is blocked.', ['url' => $url]);
$this->profiler->stopRecording();
return CurlResult::createErrorCurl($url);
return CurlResult::createErrorCurl($this->logger, $url);
}
$conf = [];
@ -176,11 +176,11 @@ class HttpClient implements ICanSendHttpRequests
$exception->hasResponse()) {
return new GuzzleResponse($exception->getResponse(), $url, $exception->getCode(), '');
} else {
return new CurlResult($url, '', ['http_code' => 500], $exception->getCode(), '');
return new CurlResult($this->logger, $url, '', ['http_code' => 500], $exception->getCode(), '');
}
} catch (InvalidArgumentException | \InvalidArgumentException $argumentException) {
$this->logger->info('Invalid Argument for HTTP call.', ['url' => $url, 'method' => $method, 'exception' => $argumentException]);
return new CurlResult($url, '', ['http_code' => 500], $argumentException->getCode(), $argumentException->getMessage());
return new CurlResult($this->logger, $url, '', ['http_code' => 500], $argumentException->getCode(), $argumentException->getMessage());
} finally {
unlink($conf['sink']);
$this->logger->debug('Request stop.', ['url' => $url, 'method' => $method]);

18
src/Network/HTTPClient/Response/CurlResult.php
View file

@ -25,6 +25,7 @@ use Friendica\Core\Logger;
use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
use Friendica\Network\HTTPException\UnprocessableEntityException;
use Friendica\Util\Network;
use Psr\Log\LoggerInterface;
/**
* A content class for Curl call results
@ -96,6 +97,11 @@ class CurlResult implements ICanHandleHttpResponses
*/
private $error;
/**
* @var LoggerInterface
*/
protected $logger;
/**
* Creates an errored CURL response
*
@ -104,9 +110,9 @@ class CurlResult implements ICanHandleHttpResponses
* @return ICanHandleHttpResponses a CURL with error response
* @throws UnprocessableEntityException
*/
public static function createErrorCurl(string $url = '')
public static function createErrorCurl(LoggerInterface $logger, string $url = '')
{
return new CurlResult($url, '', ['http_code' => 0]);
return new CurlResult($logger, $url, '', ['http_code' => 0]);
}
/**
@ -120,8 +126,10 @@ class CurlResult implements ICanHandleHttpResponses
*
* @throws UnprocessableEntityException when HTTP code of the CURL response is missing
*/
public function __construct(string $url, string $result, array $info, int $errorNumber = 0, string $error = '')
public function __construct(LoggerInterface $logger, string $url, string $result, array $info, int $errorNumber = 0, string $error = '')
{
$this->logger = $logger;
if (!array_key_exists('http_code', $info)) {
throw new UnprocessableEntityException('CURL response doesn\'t contains a response HTTP code');
}
@ -132,7 +140,7 @@ class CurlResult implements ICanHandleHttpResponses
$this->errorNumber = $errorNumber;
$this->error = $error;
Logger::debug('construct', ['url' => $url, 'returncode' => $this->returnCode, 'result' => $result]);
$this->logger->debug('construct', ['url' => $url, 'returncode' => $this->returnCode, 'result' => $result]);
$this->parseBodyHeader($result);
$this->checkSuccess();
@ -172,7 +180,7 @@ class CurlResult implements ICanHandleHttpResponses
}
if (!$this->isSuccess) {
Logger::debug('debug', ['info' => $this->info]);
$this->logger->debug('debug', ['info' => $this->info]);
}
if (!$this->isSuccess && $this->errorNumber == CURLE_OPERATION_TIMEDOUT) {