Skip to content

Commit

Permalink
chore: Remove deprecated ILogger logging functions
Browse files Browse the repository at this point in the history
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
  • Loading branch information
susnux committed Sep 18, 2024
1 parent f1dfd6b commit 5cce140
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 161 deletions.
5 changes: 3 additions & 2 deletions apps/user_ldap/lib/LDAPProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
use OCP\IServerContainer;
use OCP\LDAP\IDeletionFlagSupport;
use OCP\LDAP\ILDAPProvider;
use Psr\Log\LoggerInterface;

/**
* LDAP provider for pulic access to the LDAP backend.
* LDAP provider for public access to the LDAP backend.
*/
class LDAPProvider implements ILDAPProvider, IDeletionFlagSupport {
private $userBackend;
Expand All @@ -30,7 +31,7 @@ class LDAPProvider implements ILDAPProvider, IDeletionFlagSupport {
* @throws \Exception if user_ldap app was not enabled
*/
public function __construct(IServerContainer $serverContainer, Helper $helper, DeletedUsersIndex $deletedUsersIndex) {
$this->logger = $serverContainer->getLogger();
$this->logger = $serverContainer->get(LoggerInterface::class);
$this->helper = $helper;
$this->deletedUsersIndex = $deletedUsersIndex;
$userBackendFound = false;
Expand Down
1 change: 0 additions & 1 deletion lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,6 @@
'OC\\AppFramework\\Http\\Output' => $baseDir . '/lib/private/AppFramework/Http/Output.php',
'OC\\AppFramework\\Http\\Request' => $baseDir . '/lib/private/AppFramework/Http/Request.php',
'OC\\AppFramework\\Http\\RequestId' => $baseDir . '/lib/private/AppFramework/Http/RequestId.php',
'OC\\AppFramework\\Logger' => $baseDir . '/lib/private/AppFramework/Logger.php',
'OC\\AppFramework\\Middleware\\AdditionalScriptsMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/AdditionalScriptsMiddleware.php',
'OC\\AppFramework\\Middleware\\CompressionMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/CompressionMiddleware.php',
'OC\\AppFramework\\Middleware\\MiddlewareDispatcher' => $baseDir . '/lib/private/AppFramework/Middleware/MiddlewareDispatcher.php',
Expand Down
1 change: 0 additions & 1 deletion lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,6 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\AppFramework\\Http\\Output' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Http/Output.php',
'OC\\AppFramework\\Http\\Request' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Http/Request.php',
'OC\\AppFramework\\Http\\RequestId' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Http/RequestId.php',
'OC\\AppFramework\\Logger' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Logger.php',
'OC\\AppFramework\\Middleware\\AdditionalScriptsMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/AdditionalScriptsMiddleware.php',
'OC\\AppFramework\\Middleware\\CompressionMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/CompressionMiddleware.php',
'OC\\AppFramework\\Middleware\\MiddlewareDispatcher' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/MiddlewareDispatcher.php',
Expand Down
6 changes: 0 additions & 6 deletions lib/private/Log/LogFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

use OC\Log;
use OC\SystemConfig;
use OCP\ILogger;
use OCP\IServerContainer;
use OCP\Log\ILogFactory;
use OCP\Log\IWriter;
Expand All @@ -33,11 +32,6 @@ public function get(string $type):IWriter {
};
}

public function getCustomLogger(string $path): ILogger {
$log = $this->buildLogFile($path);
return new Log($log, $this->systemConfig);
}

protected function createNewLogger(string $type, string $tag, string $path): IWriter {
return match (strtolower($type)) {
'errorlog' => new Errorlog($this->systemConfig, $tag),
Expand Down
13 changes: 1 addition & 12 deletions lib/private/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@
use OCP\IGroupManager;
use OCP\IInitialStateService;
use OCP\IL10N;
use OCP\ILogger;
use OCP\INavigationManager;
use OCP\IPhoneNumberUtil;
use OCP\IPreview;
Expand Down Expand Up @@ -680,6 +679,7 @@ public function __construct($webRoot, \OC\Config $config) {
$this->registerAlias(\OCP\Support\Subscription\IRegistry::class, \OC\Support\Subscription\Registry::class);
$this->registerAlias(\OCP\Support\Subscription\IAssertion::class, \OC\Support\Subscription\Assertion::class);

/** Only used by the PsrLoggerAdapter should not be used by apps */
$this->registerService(\OC\Log::class, function (Server $c) {
$logType = $c->get(AllConfig::class)->getSystemValue('log_type', 'file');
$factory = new LogFactory($c, $this->get(SystemConfig::class));
Expand All @@ -688,7 +688,6 @@ public function __construct($webRoot, \OC\Config $config) {

return new Log($logger, $this->get(SystemConfig::class), crashReporters: $registry);
});
$this->registerAlias(ILogger::class, \OC\Log::class);
// PSR-3 logger
$this->registerAlias(LoggerInterface::class, PsrLoggerAdapter::class);

Expand Down Expand Up @@ -1656,16 +1655,6 @@ public function getJobList() {
return $this->get(IJobList::class);
}

/**
* Returns a logger instance
*
* @return ILogger
* @deprecated 20.0.0
*/
public function getLogger() {
return $this->get(ILogger::class);
}

/**
* @return ILogFactory
* @throws \OCP\AppFramework\QueryException
Expand Down
135 changes: 5 additions & 130 deletions lib/public/ILogger.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,157 +9,32 @@
namespace OCP;

/**
* Interface ILogger
* @since 7.0.0
* Nextcloud logging levels.
* For historical reasons the logging levels are provided as interface constants.
*
* This logger interface follows the design guidelines of PSR-3
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface
* @deprecated 20.0.0 use the PSR-3 logger \Psr\Log\LoggerInterface
* @since 7.0.0
* @since 20.0.0 deprecated logging methods in favor of \Psr\Log\LoggerInterface
* @since 31.0.0 removed deprecated logging methods - the interface is kept for Nextcloud log levels
*/
interface ILogger {
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const DEBUG = 0;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const INFO = 1;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const WARN = 2;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const ERROR = 3;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const FATAL = 4;

/**
* System is unusable.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::emergency
*/
public function emergency(string $message, array $context = []);

/**
* Action must be taken immediately.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::alert
*/
public function alert(string $message, array $context = []);

/**
* Critical conditions.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::critical
*/
public function critical(string $message, array $context = []);

/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::error
*/
public function error(string $message, array $context = []);

/**
* Exceptional occurrences that are not errors.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::warning
*/
public function warning(string $message, array $context = []);

/**
* Normal but significant events.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::notice
*/
public function notice(string $message, array $context = []);

/**
* Interesting events.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::info
*/
public function info(string $message, array $context = []);

/**
* Detailed debug information.
*
* @param string $message
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::debug
*/
public function debug(string $message, array $context = []);

/**
* Logs with an arbitrary level.
*
* @param int $level
* @param string $message
* @param array $context
* @return mixed
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::log
*/
public function log(int $level, string $message, array $context = []);

/**
* Logs an exception very detailed
* An additional message can we written to the log by adding it to the
* context.
*
* <code>
* $logger->logException($ex, [
* 'message' => 'Exception during background job execution'
* ]);
* </code>
*
* @param \Exception|\Throwable $exception
* @param array $context
* @return void
* @since 8.2.0
* @deprecated 20.0.0 use the `exception` entry in the context of any method in \Psr\Log\LoggerInterface
*/
public function logException(\Throwable $exception, array $context = []);
}
9 changes: 0 additions & 9 deletions lib/public/IServerContainer.php
Original file line number Diff line number Diff line change
Expand Up @@ -316,15 +316,6 @@ public function getAvatarManager();
*/
public function getJobList();

/**
* Returns a logger instance
*
* @return \OCP\ILogger
* @since 8.0.0
* @deprecated 20.0.0 have it injected or fetch it through \Psr\Container\ContainerInterface::get
*/
public function getLogger();

/**
* returns a log factory instance
*
Expand Down

0 comments on commit 5cce140

Please sign in to comment.