Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2024-12-31 16:42:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add Feedback :-)

Browse source
This commit is contained in:
Philipp 2021-10-29 08:03:59 +02:00
parent 409d909d0f
commit f4ea74447e
No known key found for this signature in database
GPG key ID: 24A7501396EB5432
14 changed files with 80 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/Core/Logger/Exception/LogLevelException.php Normal file
View file

@ -0,0 +1,13 @@
<?php
namespace Friendica\Core\Logger\Exception;
use Throwable;
class LogLevelException extends \InvalidArgumentException
{
public function __construct($message = "", Throwable $previous = null)
{
parent::__construct($message, 500, $previous);
}
}

39
src/Core/Logger/Factory/Logger.php
View file

@ -24,6 +24,7 @@ namespace Friendica\Core\Logger\Factory;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Database\Database;
use Friendica\Util\FileSystem;
use Friendica\Util\Introspection;
@ -54,7 +55,6 @@ class Logger
Core\Logger::class,
Profiler::class,
'Friendica\\Core\\Logger\\Type',
'Friendica\\Core\\Logger\\Type\\Monolog',
];
/** @var string The log-channel (app, worker, ...) */
@ -72,10 +72,11 @@ class Logger
* @param IManageConfigValues $config The config
* @param Profiler $profiler The profiler of the app
* @param FileSystem $fileSystem FileSystem utils
* @param string|null $minLevel (optional) Override minimum Loglevel to log
*
* @return LoggerInterface The PSR-3 compliant logger instance
*/
public function create(Database $database, IManageConfigValues $config, Profiler $profiler, FileSystem $fileSystem): LoggerInterface
public function create(Database $database, IManageConfigValues $config, Profiler $profiler, FileSystem $fileSystem, ?string $minLevel = null): LoggerInterface
{
if (empty($config->get('system', 'debugging', false))) {
$logger = new NullLogger();
@ -84,8 +85,8 @@ class Logger
}
$introspection = new Introspection(self::$ignoreClassList);
$level = $config->get('system', 'loglevel');
$loglevel = self::mapLegacyConfigDebugLevel((string)$level);
$minLevel = $minLevel ?? $config->get('system', 'loglevel');
$loglevel = self::mapLegacyConfigDebugLevel((string)$minLevel);
switch ($config->get('system', 'logger_config', 'stream')) {
case 'monolog':
@ -106,8 +107,12 @@ class Logger
static::addStreamHandler($logger, $stream, $loglevel);
} catch (\Throwable $e) {
// No Logger ..
/// @todo isn't it possible to give the admin any hint about this wrong configuration?
$logger = new NullLogger();
try {
$logger = new SyslogLogger($this->channel, $introspection, $loglevel);
} catch (\Throwable $e) {
// No logger ...
$logger = new NullLogger();
}
}
}
break;
@ -115,9 +120,12 @@ class Logger
case 'syslog':
try {
$logger = new SyslogLogger($this->channel, $introspection, $loglevel);
} catch (LogLevelException $exception) {
// If there's a wrong config value for loglevel, try again with standard
$logger = $this->create($database, $config, $profiler, $fileSystem, LogLevel::NOTICE);
$logger->warning('Invalid loglevel set in config.', ['loglevel' => $loglevel]);
} catch (\Throwable $e) {
// No logger ...
/// @todo isn't it possible to give the admin any hint about this wrong configuration?
$logger = new NullLogger();
}
break;
@ -129,14 +137,25 @@ class Logger
if (!is_file($stream) || is_writable($stream)) {
try {
$logger = new StreamLogger($this->channel, $stream, $introspection, $fileSystem, $loglevel);
} catch (LogLevelException $exception) {
// If there's a wrong config value for loglevel, try again with standard
$logger = $this->create($database, $config, $profiler, $fileSystem, LogLevel::NOTICE);
$logger->warning('Invalid loglevel set in config.', ['loglevel' => $loglevel]);
} catch (\Throwable $t) {
// No logger ...
/// @todo isn't it possible to give the admin any hint about this wrong configuration?
$logger = new NullLogger();
}
} else {
/// @todo isn't it possible to give the admin any hint about this wrong configuration?
$logger = new NullLogger();
try {
$logger = new SyslogLogger($this->channel, $introspection, $loglevel);
} catch (LogLevelException $exception) {
// If there's a wrong config value for loglevel, try again with standard
$logger = $this->create($database, $config, $profiler, $fileSystem, LogLevel::NOTICE);
$logger->warning('Invalid loglevel set in config.', ['loglevel' => $loglevel]);
} catch (\Throwable $e) {
// No logger ...
$logger = new NullLogger();
}
}
break;
}

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

@ -23,6 +23,7 @@ namespace Friendica\Core\Logger\Type;
use Friendica\Core\Logger\Exception\LoggerArgumentException;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\FileSystem;
use Friendica\Util\Introspection;
@ -83,6 +84,7 @@ class StreamLogger extends AbstractLogger
* @param string $level The minimum loglevel at which this logger will be triggered
*
* @throws LoggerArgumentException
* @throws LogLevelException
*/
public function __construct($channel, $stream, Introspection $introspection, FileSystem $fileSystem, string $level = LogLevel::DEBUG)
{
@ -102,7 +104,7 @@ class StreamLogger extends AbstractLogger
if (array_key_exists($level, $this->levelToInt)) {
$this->logLevel = $this->levelToInt[$level];
} else {
throw new LoggerArgumentException(sprintf('The level "%s" is not valid.', $level));
throw new LogLevelException(sprintf('The level "%s" is not valid.', $level));
}
$this->checkStream();
@ -127,12 +129,12 @@ class StreamLogger extends AbstractLogger
* @return void
*
* @throws LoggerException
* @throws LoggerArgumentException
* @throws LogLevelException
*/
protected function addEntry($level, string $message, array $context = [])
{
if (!array_key_exists($level, $this->levelToInt)) {
throw new LoggerArgumentException(sprintf('The level "%s" is not valid.', $level));
throw new LogLevelException(sprintf('The level "%s" is not valid.', $level));
}
$logLevel = $this->levelToInt[$level];

12
src/Core/Logger/Type/SyslogLogger.php
View file

@ -21,10 +21,9 @@
namespace Friendica\Core\Logger\Type;
use Friendica\Core\Logger\Exception\LoggerArgumentException;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Util\Introspection;
use Psr\Log\InvalidArgumentException;
use Psr\Log\LogLevel;
/**
@ -99,7 +98,8 @@ class SyslogLogger extends AbstractLogger
* @param int $logOpts Indicates what logging options will be used when generating a log message
* @param int $logFacility Used to specify what type of program is logging the message
*
* @throws LoggerArgumentException
* @throws LogLevelException
* @throws LoggerException
*/
public function __construct($channel, Introspection $introspection, string $level = LogLevel::NOTICE, int $logOpts = LOG_PID, int $logFacility = LOG_USER)
{
@ -117,7 +117,7 @@ class SyslogLogger extends AbstractLogger
* @param string $message
* @param array $context
*
* @throws LoggerArgumentException in case the level isn't valid
* @throws LogLevelException in case the level isn't valid
* @throws LoggerException In case the syslog cannot be opened for writing
*/
protected function addEntry($level, string $message, array $context = [])
@ -139,12 +139,12 @@ class SyslogLogger extends AbstractLogger
*
* @return int The SysLog priority
*
* @throws LoggerArgumentException If the loglevel isn't valid
* @throws LogLevelException If the loglevel isn't valid
*/
public function mapLevelToPriority(string $level): int
{
if (!array_key_exists($level, $this->logLevels)) {
throw new LoggerArgumentException(sprintf('The level "%s" is not valid.', $level));
throw new LogLevelException(sprintf('The level "%s" is not valid.', $level));
}
return $this->logLevels[$level];

4
src/DI.php
View file

@ -415,11 +415,11 @@ abstract class DI
//
/**
* @return Network\HTTPClient\Capability\ICanRequestPerHttp
* @return Network\HTTPClient\Capability\ICanSendHttpRequests
*/
public static function httpClient()
{
return self::$dice->create(Network\HTTPClient\Capability\ICanRequestPerHttp::class);
return self::$dice->create(Network\HTTPClient\Capability\ICanSendHttpRequests::class);
}
//

2
src/Network/HTTPClient/Capability/ICanRequestPerHttp.php → src/Network/HTTPClient/Capability/ICanSendHttpRequests.php
View file

@ -26,7 +26,7 @@ use GuzzleHttp\Exception\TransferException;
/**
* Interface for calling HTTP requests and returning their responses
*/
interface ICanRequestPerHttp
interface ICanSendHttpRequests
{
/**
* Fetches the content of an URL

4
src/Network/HTTPClient/Client/HttpClientCan.php → src/Network/HTTPClient/Client/HttpClient.php
View file

@ -24,7 +24,7 @@ namespace Friendica\Network\HTTPClient\Client;
use Friendica\Core\System;
use Friendica\Network\HTTPClient\Response\CurlResult;
use Friendica\Network\HTTPClient\Response\GuzzleResponse;
use Friendica\Network\HTTPClient\Capability\ICanRequestPerHttp;
use Friendica\Network\HTTPClient\Capability\ICanSendHttpRequests;
use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
use Friendica\Network\HTTPException\InternalServerErrorException;
use Friendica\Util\Network;
@ -42,7 +42,7 @@ use Psr\Log\LoggerInterface;
/**
* Performs HTTP requests to a given URL
*/
class HttpClientCan implements ICanRequestPerHttp
class HttpClient implements ICanSendHttpRequests
{
/** @var LoggerInterface */
private $logger;

8
src/Network/HTTPClient/Factory/HttpClient.php
View file

@ -6,7 +6,7 @@ use Friendica\App;
use Friendica\BaseFactory;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Network\HTTPClient\Client;
use Friendica\Network\HTTPClient\Capability\ICanRequestPerHttp;
use Friendica\Network\HTTPClient\Capability\ICanSendHttpRequests;
use Friendica\Util\Profiler;
use Friendica\Util\Strings;
use GuzzleHttp;
@ -42,9 +42,9 @@ class HttpClient extends BaseFactory
*
* @param HandlerStack|null $handlerStack (optional) A handler replacement (just usefull at test environments)
*
* @return ICanRequestPerHttp
* @return ICanSendHttpRequests
*/
public function createClient(HandlerStack $handlerStack = null): ICanRequestPerHttp
public function createClient(HandlerStack $handlerStack = null): ICanSendHttpRequests
{
$proxy = $this->config->get('system', 'proxy');
@ -108,6 +108,6 @@ class HttpClient extends BaseFactory
// Some websites test the browser for cookie support, so this enhances results.
$resolver->setCookieJar(get_temppath() .'/resolver-cookie-' . Strings::getRandomName(10));
return new Client\HttpClientCan($logger, $this->profiler, $guzzle, $resolver);
return new Client\HttpClient($logger, $this->profiler, $guzzle, $resolver);
}
}

4
static/dependencies.config.php
View file

@ -146,7 +146,7 @@ return [
'index',
],
'call' => [
['create', ['index'], Dice::CHAIN_CALL],
['create', [], Dice::CHAIN_CALL],
],
],
'$devLogger' => [
@ -224,7 +224,7 @@ return [
['getBackend', [], Dice::CHAIN_CALL],
],
],
Network\HTTPClient\Capability\ICanRequestPerHttp::class => [
Network\HTTPClient\Capability\ICanSendHttpRequests::class => [
'instanceOf' => Network\HTTPClient\Factory\HttpClient::class,
'call' => [
['createClient', [], Dice::CHAIN_CALL],

4
tests/DiceHttpMockHandlerTrait.php
View file

@ -24,7 +24,7 @@ namespace Friendica\Test;
use Dice\Dice;
use Friendica\DI;
use Friendica\Network\HTTPClient\Factory\HttpClient;
use Friendica\Network\HTTPClient\Capability\ICanRequestPerHttp;
use Friendica\Network\HTTPClient\Capability\ICanSendHttpRequests;
use GuzzleHttp\HandlerStack;
/**
@ -49,7 +49,7 @@ trait DiceHttpMockHandlerTrait
$dice = DI::getDice();
// addRule() clones the current instance and returns a new one, so no concurrency problems :-)
$newDice = $dice->addRule(ICanRequestPerHttp::class, [
$newDice = $dice->addRule(ICanSendHttpRequests::class, [
'instanceOf' => HttpClient::class,
'call' => [
['createClient', [$this->httpRequestHandler], Dice::CHAIN_CALL],

10
tests/src/Core/InstallerTest.php
View file

@ -26,7 +26,7 @@ use Dice\Dice;
use Friendica\Core\Config\ValueObject\Cache;
use Friendica\DI;
use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
use Friendica\Network\HTTPClient\Capability\ICanRequestPerHttp;
use Friendica\Network\HTTPClient\Capability\ICanSendHttpRequests;
use Friendica\Test\MockedTest;
use Friendica\Test\Util\VFSTrait;
use Mockery;
@ -331,7 +331,7 @@ class InstallerTest extends MockedTest
->andReturn('test Error');
// Mocking the CURL Request
$networkMock = Mockery::mock(ICanRequestPerHttp::class);
$networkMock = Mockery::mock(ICanSendHttpRequests::class);
$networkMock
->shouldReceive('fetchFull')
->with('https://test/install/testrewrite')
@ -342,7 +342,7 @@ class InstallerTest extends MockedTest
->andReturn($IHTTPResult);
$this->dice->shouldReceive('create')
->with(ICanRequestPerHttp::class)
->with(ICanSendHttpRequests::class)
->andReturn($networkMock);
DI::init($this->dice);
@ -378,7 +378,7 @@ class InstallerTest extends MockedTest
->andReturn('204');
// Mocking the CURL Request
$networkMock = Mockery::mock(ICanRequestPerHttp::class);
$networkMock = Mockery::mock(ICanSendHttpRequests::class);
$networkMock
->shouldReceive('fetchFull')
->with('https://test/install/testrewrite')
@ -389,7 +389,7 @@ class InstallerTest extends MockedTest
->andReturn($IHTTPResultW);
$this->dice->shouldReceive('create')
->with(ICanRequestPerHttp::class)
->with(ICanSendHttpRequests::class)
->andReturn($networkMock);
DI::init($this->dice);

5
tests/src/Core/Logger/StreamLoggerTest.php
View file

@ -23,6 +23,7 @@ namespace Friendica\Test\src\Core\Logger;
use Friendica\Core\Logger\Exception\LoggerArgumentException;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Util\FileSystem;
use Friendica\Test\Util\VFSTrait;
use Friendica\Core\Logger\Type\StreamLogger;
@ -160,7 +161,7 @@ class StreamLoggerTest extends AbstractLoggerTest
*/
public function testWrongMinimumLevel()
{
$this->expectException(LoggerArgumentException::class);
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logger = new StreamLogger('test', 'file.text', $this->introspection, $this->fileSystem, 'NOPE');
@ -171,7 +172,7 @@ class StreamLoggerTest extends AbstractLoggerTest
*/
public function testWrongLogLevel()
{
$this->expectException(LoggerArgumentException::class);
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logfile = vfsStream::newFile('friendica.log')

5
tests/src/Core/Logger/SyslogLoggerTest.php
View file

@ -23,6 +23,7 @@ namespace Friendica\Test\src\Core\Logger;
use Friendica\Core\Logger\Exception\LoggerArgumentException;
use Friendica\Core\Logger\Exception\LoggerException;
use Friendica\Core\Logger\Exception\LogLevelException;
use Friendica\Core\Logger\Type\SyslogLogger;
use Psr\Log\LogLevel;
@ -64,7 +65,7 @@ class SyslogLoggerTest extends AbstractLoggerTest
*/
public function testWrongMinimumLevel()
{
$this->expectException(LoggerArgumentException::class);
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logger = new SyslogLoggerWrapper('test', $this->introspection, 'NOPE');
@ -75,7 +76,7 @@ class SyslogLoggerTest extends AbstractLoggerTest
*/
public function testWrongLogLevel()
{
$this->expectException(LoggerArgumentException::class);
$this->expectException(LogLevelException::class);
$this->expectExceptionMessageMatches("/The level \".*\" is not valid./");
$logger = new SyslogLoggerWrapper('test', $this->introspection);

6
tests/src/Core/Storage/Repository/StorageManagerTest.php
View file

@ -40,7 +40,7 @@ use Friendica\DI;
use Friendica\Core\Config\Factory\Config;
use Friendica\Core\Config\Repository;
use Friendica\Core\Storage\Type;
use Friendica\Network\HTTPClient\Client\HttpClientCan;
use Friendica\Network\HTTPClient\Client\HttpClient;
use Friendica\Test\DatabaseTest;
use Friendica\Test\Util\Database\StaticDatabase;
use Friendica\Test\Util\VFSTrait;
@ -61,7 +61,7 @@ class StorageManagerTest extends DatabaseTest
private $logger;
/** @var L10n */
private $l10n;
/** @var HttpClientCan */
/** @var HttpClient */
private $httpRequest;
protected function setUp(): void
@ -93,7 +93,7 @@ class StorageManagerTest extends DatabaseTest
$this->l10n = \Mockery::mock(L10n::class);
$this->httpRequest = \Mockery::mock(HttpClientCan::class);
$this->httpRequest = \Mockery::mock(HttpClient::class);
}
protected function tearDown(): void