Skip to content
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

chore(ocp)!: Drop \OCP\Util::writeLog #38548

Closed
wants to merge 3 commits into from
+23 −62
Closed

chore(ocp)!: Drop \OCP\Util::writeLog #38548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
504a8ea
chore: Replace \OCP\Util::writeLog with \OCP\Log\logger calls
ChristophWurst May 31, 2023
76f017a
chore(ocp)!: Drop \OCP\Util::writeLog
ChristophWurst May 31, 2023
e2faf6d
chore(appframework): Remove deprecated and unused DIContainer::log
ChristophWurst May 31, 2023
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
4 changes: 2 additions & 2 deletions core/Controller/SetupController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
namespace OC\Core\Controller;

use OC\Setup;
use OCP\ILogger;
use function OCP\Log\logger;

class SetupController {
private string $autoConfigFile;
Expand Down Expand Up @@ -114,7 +114,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);
logger('core')->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 function OCP\Log\logger;

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);
logger('core')->debug('Include path for class "' . $class . '" starts with "apps/"');
$paths[] = str_replace('apps/', '', \OC::$CLASSPATH[$class]);
}
} elseif (strpos($class, 'OC_') === 0) {
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
13 changes: 7 additions & 6 deletions lib/private/Tags.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
use OCP\ITags;
use OCP\Share_Backend;
use Psr\Log\LoggerInterface;
use function OCP\Log\logger;

class Tags implements ITags {
/**
Expand Down Expand Up @@ -529,7 +530,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);
logger('core')->debug(__METHOD__.', Cannot add an empty tag');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$this->logger is also available ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥲

return false;
}
if (!$this->hasTag($tag)) {
Expand Down Expand Up @@ -569,7 +570,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);
logger('core')->debug(__METHOD__.', Tag name is empty');
return false;
}
$tagId = $this->getTagId($tag);
Expand Down Expand Up @@ -609,8 +610,8 @@ 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);
logger('core')->debug(__METHOD__ . ', before: '
. print_r($this->tags, true));
foreach ($names as $name) {
$id = null;

Expand All @@ -625,8 +626,8 @@ 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);
logger('core')->error(__METHOD__ . 'Cannot delete tag ' . $name
. ': not found.');
}
if (!is_null($id) && $id !== false) {
try {
Expand Down
14 changes: 7 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 All @@ -66,6 +65,7 @@
use OC\Repair\Events\RepairErrorEvent;
use Psr\Container\ContainerExceptionInterface;
use Psr\Log\LoggerInterface;
use function OCP\Log\logger;

/**
* This class manages the apps. It allows them to register and integrate in the
Expand Down Expand Up @@ -292,7 +292,7 @@ public static function getInstallPath() {
}
}

\OCP\Util::writeLog('core', 'No application directories are marked as writable.', ILogger::ERROR);
logger('core')->error('No application directories are marked as writable.');
return null;
}

Expand Down Expand Up @@ -517,7 +517,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);
logger('core')->warning('Unable to read app folder: ' . $apps_dir['path']);
continue;
}
$dh = opendir($apps_dir['path']);
Expand Down Expand Up @@ -568,12 +568,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);
logger('core')->error('Could not read app info file for app "' . $app . '"');
continue;
}

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

Expand Down Expand Up @@ -870,11 +870,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);
logger('core')->error('Can\'t get app storage, app ' . $appId . ', user not logged in');
return false;
}
} else {
\OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', ILogger::ERROR);
logger('core')->error('Can\'t get app storage, app ' . $appId . ' not enabled');
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 function OCP\Log\logger;

/**
* 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);
logger('core')->debug('Adding user backend ' . $backend . '.');
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);
logger('core')->debug('Adding default user backend ' . $backend . '.');
$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);
logger('core')->debug('User backend ' . $class . ' already initialized.');
}
} else {
\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
logger('core')->error('User backend ' . $class . ' not found.');
}
}
}
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