refactor: Delete deprecated code from OC_Util

Signed-off-by: Carl Schwan <carlschwan@kde.org>

Author: CarlSchwan

apps/updatenotification/lib/Controller/AdminController.php

@@ -20,7 +20,7 @@
 use OCP\IL10N;
 use OCP\IRequest;
 use OCP\Security\ISecureRandom;
-use OCP\Util;
+use OCP\ServerVersion;
 use Psr\Log\LoggerInterface;
 
 class AdminController extends Controller {
@@ -35,16 +35,16 @@ public function __construct(
 		private ITimeFactory $timeFactory,
 		private IL10N $l10n,
 		private LoggerInterface $logger,
+		private ServerVersion $serverVersion,
 	) {
 		parent::__construct($appName, $request);
 	}
 
 	/**
-	 * @param string $channel
-	 * @return DataResponse
+	 * @param 'beta'|'stable'|'enterprise'|'git' $channel
 	 */
 	public function setChannel(string $channel): DataResponse {
-		Util::setChannel($channel);
+		$this->serverVersion->setChannel($channel);
 		$this->appConfig->setValueInt('core', 'lastupdatedat', 0);
 		return new DataResponse(['status' => 'success', 'data' => ['message' => $this->l10n->t('Channel updated')]]);
 	}

apps/updatenotification/tests/Controller/AdminControllerTest.php

@@ -18,6 +18,7 @@
 use OCP\IL10N;
 use OCP\IRequest;
 use OCP\Security\ISecureRandom;
+use OCP\ServerVersion;
 use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;
 use Test\TestCase;
@@ -56,6 +57,7 @@ protected function setUp(): void {
 			$this->timeFactory,
 			$this->l10n,
 			$this->logger,
+			$this->createMock(ServerVersion::class),
 		);
 	}
 

lib/private/AppFramework/Middleware/Security/SecurityMiddleware.php

@@ -47,7 +47,6 @@
 use OCP\IUserSession;
 use OCP\Security\Ip\IRemoteAddress;
 use OCP\Server;
-use OCP\Util;
 use Psr\Log\LoggerInterface;
 use ReflectionMethod;
 

lib/private/legacy/OC_User.php

@@ -30,7 +30,6 @@
 use OCP\User\Events\BeforeUserLoggedInEvent;
 use OCP\User\Events\UserLoggedInEvent;
 use OCP\UserInterface;
-use OCP\Util;
 use Psr\Log\LoggerInterface;
 
 /**

lib/private/legacy/OC_Util.php

@@ -565,44 +565,6 @@ public static function checkLoggedIn(): void {
 		}
 	}
 
-	/**
-	 * Check if the user is a admin, redirects to home if not
-	 *
-	 * @deprecated 32.0.0
-	 */
-	public static function checkAdminUser(): void {
-		self::checkLoggedIn();
-		if (!OC_User::isAdminUser(OC_User::getUser())) {
-			header('Location: ' . Util::linkToAbsolute('', 'index.php'));
-			exit();
-		}
-	}
-
-	/**
-	 * Returns the URL of the default page
-	 * based on the system configuration and
-	 * the apps visible for the current user
-	 *
-	 * @return string URL
-	 * @deprecated 32.0.0 use IURLGenerator's linkToDefaultPageUrl directly
-	 */
-	public static function getDefaultPageUrl() {
-		/** @var IURLGenerator $urlGenerator */
-		$urlGenerator = Server::get(IURLGenerator::class);
-		return $urlGenerator->linkToDefaultPageUrl();
-	}
-
-	/**
-	 * Redirect to the user default page
-	 *
-	 * @deprecated 32.0.0
-	 */
-	public static function redirectToDefaultPage(): void {
-		$location = self::getDefaultPageUrl();
-		header('Location: ' . $location);
-		exit();
-	}
-
 	/**
 	 * get an id unique for this instance
 	 *
@@ -618,45 +580,6 @@ public static function getInstanceId(): string {
 		return $id;
 	}
 
-	/**
-	 * Public function to sanitize HTML
-	 *
-	 * This function is used to sanitize HTML and should be applied on any
-	 * string or array of strings before displaying it on a web page.
-	 *
-	 * @param string|string[] $value
-	 * @return ($value is array ? string[] : string)
-	 * @deprecated 32.0.0 use \OCP\Util::sanitizeHTML instead
-	 */
-	public static function sanitizeHTML($value) {
-		if (is_array($value)) {
-			$value = array_map(function ($value) {
-				return self::sanitizeHTML($value);
-			}, $value);
-		} else {
-			// Specify encoding for PHP<5.4
-			$value = htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
-		}
-		return $value;
-	}
-
-	/**
-	 * Public function to encode url parameters
-	 *
-	 * This function is used to encode path to file before output.
-	 * Encoding is done according to RFC 3986 with one exception:
-	 * Character '/' is preserved as is.
-	 *
-	 * @param string $component part of URI to encode
-	 * @return string
-	 * @deprecated 32.0.0 use \OCP\Util::encodePath instead
-	 */
-	public static function encodePath($component) {
-		$encoded = rawurlencode($component);
-		$encoded = str_replace('%2F', '/', $encoded);
-		return $encoded;
-	}
-
 	/**
 	 * Check if current locale is non-UTF8
 	 *

lib/public/ServerVersion.php

@@ -91,6 +91,16 @@ public function getChannel(): string {
 		return $this->channel;
 	}
 
+	/**
+	 * Set current update channel.
+	 *
+	 * @param 'beta'|'stable'|'enterprise'|'git' $channel
+	 * @since 34.0.0
+	 */
+	public function setChannel(string $channel): void {
+		Server::get(IConfig::class)->setSystemValue('updater.release.channel', $channel);
+	}
+
 	/**
 	 * @since 31.0.0
 	 */

lib/public/Util.php

@@ -51,16 +51,17 @@ public static function hasExtendedSupport(): bool {
 			return $subscriptionRegistry->delegateHasExtendedSupport();
 		} catch (ContainerExceptionInterface $e) {
 		}
-		return \OCP\Server::get(IConfig::class)->getSystemValueBool('extendedSupport', false);
+		return Server::get(IConfig::class)->getSystemValueBool('extendedSupport', false);
 	}
 
 	/**
 	 * Set current update channel
 	 * @param string $channel
 	 * @since 8.1.0
+	 * @deprecated 33.0.0 Use \OCP\ServerVersion::setChannel
 	 */
 	public static function setChannel($channel) {
-		\OCP\Server::get(IConfig::class)->setSystemValue('updater.release.channel', $channel);
+		Server::get(IConfig::class)->setSystemValue('updater.release.channel', $channel);
 	}
 
 	/**
@@ -70,7 +71,7 @@ public static function setChannel($channel) {
 	 * @deprecated 31.0.0 Use \OCP\ServerVersion::getChannel
 	 */
 	public static function getChannel() {
-		return \OCP\Server::get(ServerVersion::class)->getChannel();
+		return Server::get(ServerVersion::class)->getChannel();
 	}
 
 	/**
@@ -182,7 +183,7 @@ public static function addScript(string $application, ?string $file = null, stri
 	 */
 	public static function getScripts(): array {
 		// Sort scriptDeps into sortedScriptDeps
-		$scriptSort = \OCP\Server::get(AppScriptSort::class);
+		$scriptSort = Server::get(AppScriptSort::class);
 		$sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
 
 		// Flatten array and remove duplicates
@@ -209,7 +210,7 @@ public static function getScripts(): array {
 	 */
 	public static function addTranslations($application, $languageCode = null, $init = false) {
 		if (is_null($languageCode)) {
-			$languageCode = \OCP\Server::get(IFactory::class)->findLanguage($application);
+			$languageCode = Server::get(IFactory::class)->findLanguage($application);
 		}
 		if (!empty($application)) {
 			$path = "$application/l10n/$languageCode";
@@ -273,7 +274,7 @@ public static function linkToRemote(string $service): string {
 	 * @since 5.0.0
 	 */
 	public static function getServerHostName() {
-		$host_name = \OCP\Server::get(IRequest::class)->getServerHost();
+		$host_name = Server::get(IRequest::class)->getServerHost();
 		// strip away port number (if existing)
 		$colon_pos = strpos($host_name, ':');
 		if ($colon_pos != false) {
@@ -299,13 +300,13 @@ public static function getServerHostName() {
 	 * @since 5.0.0
 	 */
 	public static function getDefaultEmailAddress(string $user_part): string {
-		$config = \OCP\Server::get(IConfig::class);
+		$config = Server::get(IConfig::class);
 		$user_part = $config->getSystemValueString('mail_from_address', $user_part);
 		$host_name = self::getServerHostName();
 		$host_name = $config->getSystemValueString('mail_domain', $host_name);
 		$defaultEmailAddress = $user_part . '@' . $host_name;
 
-		$emailValidator = \OCP\Server::get(IEmailValidator::class);
+		$emailValidator = Server::get(IEmailValidator::class);
 		if ($emailValidator->isValid($defaultEmailAddress)) {
 			return $defaultEmailAddress;
 		}
@@ -447,7 +448,7 @@ public static function emitHook($signalclass, $signalname, $params = []) {
 	 */
 	public static function callRegister() {
 		if (self::$token === '') {
-			self::$token = \OCP\Server::get(CsrfTokenManager::class)->getToken()->getEncryptedValue();
+			self::$token = Server::get(CsrfTokenManager::class)->getToken()->getEncryptedValue();
 		}
 		return self::$token;
 	}
@@ -462,8 +463,14 @@ public static function callRegister() {
 	 * @return ($value is array ? string[] : string) an array of sanitized strings or a single sanitized string, depends on the input parameter.
 	 * @since 4.5.0
 	 */
-	public static function sanitizeHTML($value) {
-		return \OC_Util::sanitizeHTML($value);
+	public static function sanitizeHTML(string|array $value): string|array {
+		if (is_array($value)) {
+			return array_map(function (string $value): string {
+				return htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
+			}, $value);
+		}
+		// Specify encoding for PHP<5.4
+		return htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
 	}
 
 	/**
@@ -477,8 +484,9 @@ public static function sanitizeHTML($value) {
 	 * @return string
 	 * @since 6.0.0
 	 */
-	public static function encodePath($component) {
-		return \OC_Util::encodePath($component);
+	public static function encodePath(string $component): string {
+		$encoded = rawurlencode($component);
+		return str_replace('%2F', '/', $encoded);
 	}
 
 	/**
@@ -619,7 +627,7 @@ public static function isDefaultExpireDateEnforced() {
 	 */
 	public static function needUpgrade() {
 		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache = \OC_Util::needUpgrade(\OCP\Server::get(\OC\SystemConfig::class));
+			self::$needUpgradeCache = \OC_Util::needUpgrade(Server::get(\OC\SystemConfig::class));
 		}
 		return self::$needUpgradeCache;
 	}

tests/lib/NavigationManagerTest.php

@@ -23,7 +23,6 @@
 use OCP\L10N\IFactory;
 use OCP\Navigation\Events\LoadAdditionalEntriesEvent;
 use OCP\Server;
-use OCP\Util;
 use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;