use Friendica\Core\Logger;
use Friendica\Database\Database;
use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\Util\FileSystem;
use Friendica\Util\Introspection;
use Friendica\Util\Logger\Monolog\DevelopHandler;
use Friendica\Util\Logger\Monolog\IntrospectionProcessor;
* @param Database $database The Friendica Database instance
* @param Configuration $config The config
* @param Profiler $profiler The profiler of the app
+ * @param FileSystem $fileSystem FileSystem utils
*
* @return LoggerInterface The PSR-3 compliant logger instance
- *
- * @throws \Exception
- * @throws InternalServerErrorException
*/
- public function create( Database $database, Configuration $config, Profiler $profiler)
+ public function create(Database $database, Configuration $config, Profiler $profiler, FileSystem $fileSystem)
{
if (empty($config->get('system', 'debugging', false))) {
$logger = new VoidLogger();
// just add a stream in case it's either writable or not file
if (!is_file($stream) || is_writable($stream)) {
- static::addStreamHandler($logger, $stream, $loglevel);
+ try {
+ static::addStreamHandler($logger, $stream, $loglevel);
+ } catch (\Throwable $e) {
+ // No Logger ..
+ $logger = new VoidLogger();
+ }
}
break;
case 'syslog':
- $logger = new SyslogLogger($this->channel, $introspection, $loglevel);
+ try {
+ $logger = new SyslogLogger($this->channel, $introspection, $loglevel);
+ } catch (\Throwable $e) {
+ // No logger ...
+ $logger = new VoidLogger();
+ }
break;
case 'stream':
$stream = $config->get('system', 'logfile');
// just add a stream in case it's either writable or not file
if (!is_file($stream) || is_writable($stream)) {
- $logger = new StreamLogger($this->channel, $stream, $introspection, $loglevel);
+ try {
+ $logger = new StreamLogger($this->channel, $stream, $introspection, $fileSystem, $loglevel);
+ } catch (\Throwable $t) {
+ // No logger ...
+ $logger = new VoidLogger();
+ }
} else {
$logger = new VoidLogger();
}
*
* @param Configuration $config The config
* @param Profiler $profiler The profiler of the app
+ * @param FileSystem $fileSystem FileSystem utils
*
* @return LoggerInterface The PSR-3 compliant logger instance
*
* @throws InternalServerErrorException
* @throws \Exception
*/
- public static function createDev(Configuration $config, Profiler $profiler)
+ public static function createDev(Configuration $config, Profiler $profiler, FileSystem $fileSystem)
{
$debugging = $config->get('system', 'debugging');
$stream = $config->get('system', 'dlogfile');
case 'stream':
default:
- $logger = new StreamLogger(self::DEV_CHANNEL, $stream, $introspection, LogLevel::DEBUG);
+ $logger = new StreamLogger(self::DEV_CHANNEL, $stream, $introspection, $fileSystem, LogLevel::DEBUG);
break;
}
return LogLevel::INFO;
// legacy DATA
case "4":
- return LogLevel::DEBUG;
// legacy ALL
case "5":
return LogLevel::DEBUG;
*
* @return void
*
- * @throws InternalServerErrorException if the logger is incompatible to the logger factory
* @throws \Exception in case of general failures
*/
public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
$fileHandler->setFormatter($formatter);
$logger->pushHandler($fileHandler);
- } else {
- throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
}
}
use Friendica\Module\BaseAdminModule;
use Friendica\Util\ConfigFileLoader;
use Friendica\Util\DateTimeFormat;
+use Friendica\Util\FileSystem;
use Friendica\Util\Network;
class Summary extends BaseAdminModule
// Check logfile permission
if (Config::get('system', 'debugging')) {
- $stream = Config::get('system', 'logfile');
+ $file = Config::get('system', 'logfile');
- if (is_file($stream) &&
- !is_writeable($stream)) {
- $warningtext[] = L10n::t('The logfile \'%s\' is not writable. No logging possible', $stream);
+ /** @var FileSystem $fileSystem */
+ $fileSystem = self::getClass(FileSystem::class);
+
+ try {
+ $stream = $fileSystem->createStream($file);
+
+ if (is_file($stream) &&
+ !is_writeable($stream)) {
+ $warningtext[] = L10n::t('The logfile \'%s\' is not writable. No logging possible', $stream);
+ }
+
+ } catch (\Throwable $exception) {
+ $warningtext[] = L10n::t('The logfile \'%s\' is not usable. No logging possible (error: \'%s\')', $file, $exception->getMessage());
}
$stream = Config::get('system', 'dlogfile');
--- /dev/null
+<?php
+
+namespace Friendica\Util;
+
+/**
+ * Util class for filesystem manipulation
+ */
+final class FileSystem
+{
+ /**
+ * @var string a error message
+ */
+ private $errorMessage;
+
+ /**
+ * Creates a directory based on a file, which gets accessed
+ *
+ * @param string $file The file
+ *
+ * @return string The directory name (empty if no directory is found, like urls)
+ */
+ public function createDir(string $file)
+ {
+ $dirname = null;
+ $pos = strpos($file, '://');
+
+ if (!$pos) {
+ $dirname = realpath(dirname($file));
+ }
+
+ if (substr($file, 0, 7) === 'file://') {
+ $dirname = realpath(dirname(substr($file, 7)));
+ }
+
+ if (isset($dirname) && !is_dir($dirname)) {
+ set_error_handler([$this, 'customErrorHandler']);
+ $status = mkdir($dirname, 0777, true);
+ restore_error_handler();
+
+ if (!$status && !is_dir($dirname)) {
+ throw new \UnexpectedValueException(sprintf('Directory "%s" cannot get created: ' . $this->errorMessage, $dirname));
+ }
+
+ return $dirname;
+ } elseif (isset($dirname) && is_dir($dirname)) {
+ return $dirname;
+ } else {
+ return '';
+ }
+ }
+
+ /**
+ * Creates a stream based on a URL (could be a local file or a real URL)
+ *
+ * @param string $url The file/url
+ *
+ * @return false|resource the open stream ressource
+ */
+ public function createStream(string $url)
+ {
+ $directory = $this->createDir($url);
+ set_error_handler([$this, 'customErrorHandler']);
+ if (!empty($directory)) {
+ $url = $directory . DIRECTORY_SEPARATOR . pathinfo($url, PATHINFO_BASENAME);
+ }
+
+ $stream = fopen($url, 'ab');
+ restore_error_handler();
+
+ if (!is_resource($stream)) {
+ throw new \UnexpectedValueException(sprintf('The stream or file "%s" could not be opened: ' . $this->errorMessage, $url));
+ }
+
+ return $stream;
+ }
+
+ private function customErrorHandler($code, $msg)
+ {
+ $this->errorMessage = preg_replace('{^(fopen|mkdir)\(.*?\): }', '', $msg);
+ }
+}
namespace Friendica\Util\Logger;
use Friendica\Util\DateTimeFormat;
+use Friendica\Util\FileSystem;
use Friendica\Util\Introspection;
use Psr\Log\LogLevel;
private $pid;
/**
- * An error message
- * @var string
+ * @var FileSystem
*/
- private $errorMessage;
+ private $fileSystem;
/**
* Translates LogLevel log levels to integer values
*
* @throws \Exception
*/
- public function __construct($channel, $stream, Introspection $introspection, $level = LogLevel::DEBUG)
+ public function __construct($channel, $stream, Introspection $introspection, FileSystem $fileSystem, $level = LogLevel::DEBUG)
{
+ $this->fileSystem = $fileSystem;
+
parent::__construct($channel, $introspection);
if (is_resource($stream)) {
} else {
throw new \InvalidArgumentException(sprintf('The level "%s" is not valid.', $level));
}
+
+ $this->checkStream();
}
public function close()
throw new \LogicException('Missing stream URL.');
}
- $this->createDir();
- set_error_handler([$this, 'customErrorHandler']);
- $this->stream = fopen($this->url, 'ab');
- restore_error_handler();
-
- if (!is_resource($this->stream)) {
- $this->stream = null;
-
- throw new \UnexpectedValueException(sprintf('The stream or file "%s" could not be opened: ' . $this->errorMessage, $this->url));
- }
- }
-
- private function createDir()
- {
- $dirname = null;
- $pos = strpos($this->url, '://');
- if (!$pos) {
- $dirname = dirname($this->url);
- }
-
- if (substr($this->url, 0, 7) === 'file://') {
- $dirname = dirname(substr($this->url, 7));
- }
-
- if (isset($dirname) && !is_dir($dirname)) {
- set_error_handler([$this, 'customErrorHandler']);
- $status = mkdir($dirname, 0777, true);
- restore_error_handler();
-
- if (!$status && !is_dir($dirname)) {
- throw new \UnexpectedValueException(sprintf('Directory "%s" cannot get created: ' . $this->errorMessage, $dirname));
- }
- }
- }
-
- private function customErrorHandler($code, $msg)
- {
- $this->errorMessage = preg_replace('{^(fopen|mkdir)\(.*?\): }', '', $msg);
+ $this->stream = $this->fileSystem->createStream($this->url);
}
}
namespace Friendica\Test\src\Util\Logger;
+use Friendica\Util\FileSystem;
use Friendica\Test\Util\VFSTrait;
use Friendica\Util\Logger\StreamLogger;
use org\bovigo\vfs\vfsStream;
*/
private $logfile;
+ /**
+ * @var Filesystem
+ */
+ private $fileSystem;
+
protected function setUp()
{
parent::setUp();
$this->setUpVfsDir();
+
+ $this->fileSystem = new Filesystem();
}
/**
$this->logfile = vfsStream::newFile('friendica.log')
->at($this->root);
- $this->logger = new StreamLogger('test', $this->logfile->url(), $this->introspection, $level);
+ $this->logger = new StreamLogger('test', $this->logfile->url(), $this->introspection, $this->fileSystem, $level);
return $this->logger;
}
$filehandler = fopen($logfile->url(), 'ab');
- $logger = new StreamLogger('test', $filehandler, $this->introspection);
+ $logger = new StreamLogger('test', $filehandler, $this->introspection, $this->fileSystem);
$logger->emergency('working');
$text = $logfile->getContent();
$logfile = vfsStream::newFile('friendica.log')
->at($this->root);
- $logger = new StreamLogger('test', $logfile->url(), $this->introspection);
+ $logger = new StreamLogger('test', $logfile->url(), $this->introspection, $this->fileSystem);
$logger->emergency('working');
$logger->close();
// close doesn't affect
*/
public function testNoUrl()
{
- $logger = new StreamLogger('test', '', $this->introspection);
+ $logger = new StreamLogger('test', '', $this->introspection, $this->fileSystem);
$logger->emergency('not working');
}
$logfile = vfsStream::newFile('friendica.log')
->at($this->root)->chmod(0);
- $logger = new StreamLogger('test', $logfile->url(), $this->introspection);
+ $logger = new StreamLogger('test', $logfile->url(), $this->introspection, $this->fileSystem);
$logger->emergency('not working');
}
{
$this->markTestIncomplete('We need a platform independent way to set directory to readonly');
- $logger = new StreamLogger('test', '/$%/wrong/directory/file.txt', $this->introspection);
+ $logger = new StreamLogger('test', '/$%/wrong/directory/file.txt', $this->introspection, $this->fileSystem);
$logger->emergency('not working');
}
*/
public function testWrongMinimumLevel()
{
- $logger = new StreamLogger('test', 'file.text', $this->introspection, 'NOPE');
+ $logger = new StreamLogger('test', 'file.text', $this->introspection, $this->fileSystem, 'NOPE');
}
/**
$logfile = vfsStream::newFile('friendica.log')
->at($this->root);
- $logger = new StreamLogger('test', $logfile->url(), $this->introspection);
+ $logger = new StreamLogger('test', $logfile->url(), $this->introspection, $this->fileSystem);
$logger->log('NOPE', 'a test');
}
*/
public function testWrongFile()
{
- $logger = new StreamLogger('test', null, $this->introspection);
+ $logger = new StreamLogger('test', null, $this->introspection, $this->fileSystem);
+ }
+
+ /**
+ * Test a relative path
+ */
+ public function testRealPath()
+ {
+ $this->markTestSkipped('vfsStream isn\'t compatible with chdir, so not testable.');
+
+ $logfile = vfsStream::newFile('friendica.log')
+ ->at($this->root);
+
+ chdir($this->root->getChild('logs')->url());
+
+ $logger = new StreamLogger('test', '../friendica.log' , $this->introspection, $this->fileSystem);
+
+ $logger->info('Test');
}
}
projects / friendica.git / commitdiff