Skip to content

Remove deprecated methods Util::writeLog and DIContainer::log #40565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
come-nc merged 1 commit into from
Sep 26, 2023
Merged

Remove deprecated methods Util::writeLog and DIContainer::log #40565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions core/Controller/SetupController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@
namespace OC\Core\Controller;

use OC\Setup;
use OCP\ILogger;
use Psr\Log\LoggerInterface;

class SetupController {
private string $autoConfigFile;

public function __construct(
protected Setup $setupHelper,
protected LoggerInterface $logger,
) {
$this->autoConfigFile = \OC::$configDir.'autoconfig.php';
}
Expand Down Expand Up @@ -78,7 +79,7 @@ public function run(array $post): void {
}
}

private function displaySetupForbidden() {
private function displaySetupForbidden(): void {
\OC_Template::printGuestPage('', 'installation_forbidden');
}

Expand All @@ -98,7 +99,7 @@ public function display($post): void {
\OC_Template::printGuestPage('', 'installation', $parameters);
}

private function finishSetup() {
private function finishSetup(): void {
if (file_exists($this->autoConfigFile)) {
unlink($this->autoConfigFile);
}
Expand All @@ -114,7 +115,7 @@ private function finishSetup() {

public function loadAutoConfig(array $post): array {
if (file_exists($this->autoConfigFile)) {
\OCP\Util::writeLog('core', 'Autoconfig file found, setting up Nextcloud…', ILogger::INFO);
$this->logger->info('Autoconfig file found, setting up Nextcloud…');
$AUTOCONFIG = [];
include $this->autoConfigFile;
$post = array_merge($post, $AUTOCONFIG);
Expand Down
4 changes: 2 additions & 2 deletions lib/autoloader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@
namespace OC;

use \OCP\AutoloadNotAllowedException;
use OCP\ILogger;
use OCP\ICache;
use Psr\Log\LoggerInterface;

class Autoloader {
/** @var bool */
Expand Down Expand Up @@ -105,7 +105,7 @@ public function findClass(string $class): array {
* Remove "apps/" from inclusion path for smooth migration to multi app dir
*/
if (strpos(\OC::$CLASSPATH[$class], 'apps/') === 0) {
\OCP\Util::writeLog('core', 'include path for class "' . $class . '" starts with "apps/"', ILogger::DEBUG);
\OCP\Server::get(LoggerInterface::class)->debug('include path for class "' . $class . '" starts with "apps/"', ['app' => 'core']);
$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
}
} elseif (strpos($class, 'OC_') === 0) {
Expand Down
5 changes: 3 additions & 2 deletions lib/base.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -988,16 +988,17 @@ public static function handleRequest(): void {
// Check if Nextcloud is installed or in maintenance (update) mode
if (!$systemConfig->getValue('installed', false)) {
\OC::$server->getSession()->clear();
$logger = Server::get(\Psr\Log\LoggerInterface::class);
$setupHelper = new OC\Setup(
$systemConfig,
Server::get(\bantu\IniGetWrapper\IniGetWrapper::class),
Server::get(\OCP\L10N\IFactory::class)->get('lib'),
Server::get(\OCP\Defaults::class),
Server::get(\Psr\Log\LoggerInterface::class),
$logger,
Server::get(\OCP\Security\ISecureRandom::class),
Server::get(\OC\Installer::class)
);
$controller = new OC\Core\Controller\SetupController($setupHelper);
$controller = new OC\Core\Controller\SetupController($setupHelper, $logger);
$controller->run($_POST);
exit();
}
Expand Down
27 changes: 0 additions & 27 deletions lib/private/AppFramework/DependencyInjection/DIContainer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,33 +403,6 @@ private function getUserId() {
return $this->getServer()->getSession()->get('user_id');
}

/**
* @deprecated use the ILogger instead
* @param string $message
* @param string $level
* @return mixed
*/
public function log($message, $level) {
switch ($level) {
case 'debug':
$level = ILogger::DEBUG;
break;
case 'info':
$level = ILogger::INFO;
break;
case 'warn':
$level = ILogger::WARN;
break;
case 'fatal':
$level = ILogger::FATAL;
break;
default:
$level = ILogger::ERROR;
break;
}
\OCP\Util::writeLog($this->getAppName(), $message, $level);
}

/**
* Register a capability
*
Expand Down
10 changes: 4 additions & 6 deletions lib/private/Tags.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@ public function tagAs($objid, $tag) {
if (is_string($tag) && !is_numeric($tag)) {
$tag = trim($tag);
if ($tag === '') {
\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', ILogger::DEBUG);
$this->logger->debug(__METHOD__.', Cannot add an empty tag');
return false;
}
if (!$this->hasTag($tag)) {
Expand Down Expand Up @@ -569,7 +569,7 @@ public function unTag($objid, $tag) {
if (is_string($tag) && !is_numeric($tag)) {
$tag = trim($tag);
if ($tag === '') {
\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', ILogger::DEBUG);
$this->logger->debug(__METHOD__.', Tag name is empty');
return false;
}
$tagId = $this->getTagId($tag);
Expand Down Expand Up @@ -609,8 +609,7 @@ public function delete($names) {
$names = array_map('trim', $names);
array_filter($names);

\OCP\Util::writeLog('core', __METHOD__ . ', before: '
. print_r($this->tags, true), ILogger::DEBUG);
$this->logger->debug(__METHOD__ . ', before: ' . print_r($this->tags, true));
foreach ($names as $name) {
$id = null;

Expand All @@ -625,8 +624,7 @@ public function delete($names) {
unset($this->tags[$key]);
$this->mapper->delete($tag);
} else {
\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
. ': not found.', ILogger::ERROR);
$this->logger->error(__METHOD__ . 'Cannot delete tag ' . $name . ': not found.');
}
if (!is_null($id) && $id !== false) {
try {
Expand Down
13 changes: 6 additions & 7 deletions lib/private/legacy/OC_App.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
use OCP\App\ManagerEvent;
use OCP\Authentication\IAlternativeLogin;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\ILogger;
use OC\AppFramework\Bootstrap\Coordinator;
use OC\App\DependencyAnalyzer;
use OC\App\Platform;
Expand Down Expand Up @@ -292,7 +291,7 @@ public static function getInstallPath() {
}
}

\OCP\Util::writeLog('core', 'No application directories are marked as writable.', ILogger::ERROR);
\OCP\Server::get(LoggerInterface::class)->error('No application directories are marked as writable.', ['app' => 'core']);
return null;
}

Expand Down Expand Up @@ -517,7 +516,7 @@ public static function getAllApps(): array {

foreach (OC::$APPSROOTS as $apps_dir) {
if (!is_readable($apps_dir['path'])) {
\OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], ILogger::WARN);
\OCP\Server::get(LoggerInterface::class)->warning('unable to read app folder : ' . $apps_dir['path'], ['app' => 'core']);
continue;
}
$dh = opendir($apps_dir['path']);
Expand Down Expand Up @@ -568,12 +567,12 @@ public function listAllApps(): array {
if (array_search($app, $blacklist) === false) {
$info = $appManager->getAppInfo($app, false, $langCode);
if (!is_array($info)) {
\OCP\Util::writeLog('core', 'Could not read app info file for app "' . $app . '"', ILogger::ERROR);
\OCP\Server::get(LoggerInterface::class)->error('Could not read app info file for app "' . $app . '"', ['app' => 'core']);
continue;
}

if (!isset($info['name'])) {
\OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', ILogger::ERROR);
\OCP\Server::get(LoggerInterface::class)->error('App id "' . $app . '" has no name in appinfo', ['app' => 'core']);
continue;
}

Expand Down Expand Up @@ -870,11 +869,11 @@ public static function getStorage(string $appId) {
}
return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId);
} else {
\OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', ILogger::ERROR);
\OCP\Server::get(LoggerInterface::class)->error('Can\'t get app storage, app ' . $appId . ', user not logged in', ['app' => 'core']);
return false;
}
} else {
\OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', ILogger::ERROR);
\OCP\Server::get(LoggerInterface::class)->error('Can\'t get app storage, app ' . $appId . ' not enabled', ['app' => 'core']);
return false;
}
}
Expand Down
10 changes: 5 additions & 5 deletions lib/private/legacy/OC_User.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@

use OC\User\LoginException;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\ILogger;
use OCP\IUserManager;
use OCP\User\Events\BeforeUserLoggedInEvent;
use OCP\User\Events\UserLoggedInEvent;
use Psr\Log\LoggerInterface;

/**
* This class provides wrapper methods for user management. Multiple backends are
Expand Down Expand Up @@ -93,7 +93,7 @@ public static function useBackend($backend = 'database') {
case 'database':
case 'mysql':
case 'sqlite':
\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', ILogger::DEBUG);
\OCP\Server::get(LoggerInterface::class)->debug('Adding user backend ' . $backend . '.', ['app' => 'core']);
self::$_usedBackends[$backend] = new \OC\User\Database();
\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
break;
Expand All @@ -102,7 +102,7 @@ public static function useBackend($backend = 'database') {
\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
break;
default:
\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', ILogger::DEBUG);
\OCP\Server::get(LoggerInterface::class)->debug('Adding default user backend ' . $backend . '.', ['app' => 'core']);
$className = 'OC_USER_' . strtoupper($backend);
self::$_usedBackends[$backend] = new $className();
\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
Expand Down Expand Up @@ -147,10 +147,10 @@ public static function setupBackends() {
self::useBackend($backend);
self::$_setupedBackends[] = $i;
} else {
\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', ILogger::DEBUG);
\OCP\Server::get(LoggerInterface::class)->debug('User backend ' . $class . ' already initialized.', ['app' => 'core']);
}
} else {
\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
\OCP\Server::get(LoggerInterface::class)->error('User backend ' . $class . ' not found.', ['app' => 'core']);
}
}
}
Expand Down
13 changes: 0 additions & 13 deletions lib/public/Util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,6 @@ public static function getChannel() {
return \OC_Util::getChannel();
}

/**
* write a message in the log
* @param string $app
* @param string $message
* @param int $level
* @since 4.0.0
* @deprecated 13.0.0 use log of \OCP\ILogger
*/
public static function writeLog($app, $message, $level) {
$context = ['app' => $app];
\OC::$server->getLogger()->log($level, $message, $context);
}

/**
* check if sharing is disabled for the current user
*
Expand Down