fix: Deprecate OC_Template, add proper template manager instead

Signed-off-by: Côme Chilliet <[email protected]>

Author: come-nc

Diff for: build/psalm-baseline-ocp.xml

@@ -1,10 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
-  <file src="lib/private/legacy/OC_Template.php">
-    <UndefinedClass>
-      <code><![CDATA[OC]]></code>
-    </UndefinedClass>
-  </file>
   <file src="lib/public/AppFramework/ApiController.php">
     <NoInterfaceProperties>
       <code><![CDATA[$this->request->server]]></code>

Diff for: core/Controller/SetupController.php

@@ -8,6 +8,7 @@
 namespace OC\Core\Controller;
 
 use OC\Setup;
+use OCP\Template\ITemplateManager;
 use OCP\Util;
 use Psr\Log\LoggerInterface;
 
@@ -17,6 +18,7 @@ class SetupController {
 	public function __construct(
 		protected Setup $setupHelper,
 		protected LoggerInterface $logger,
+		protected ITemplateManager $templateManager,
 	) {
 		$this->autoConfigFile = \OC::$configDir . 'autoconfig.php';
 	}
@@ -57,10 +59,10 @@ public function run(array $post): void {
 	}
 
 	private function displaySetupForbidden(): void {
-		\OC_Template::printGuestPage('', 'installation_forbidden');
+		$this->templateManager->printGuestPage('', 'installation_forbidden');
 	}
 
-	public function display($post): void {
+	public function display(array $post): void {
 		$defaults = [
 			'adminlogin' => '',
 			'adminpass' => '',
@@ -80,7 +82,7 @@ public function display($post): void {
 		Util::addScript('core', 'main');
 		Util::addTranslations('core');
 
-		\OC_Template::printGuestPage('', 'installation', $parameters);
+		$this->templateManager->printGuestPage('', 'installation', $parameters);
 	}
 
 	private function finishSetup(): void {
@@ -90,7 +92,7 @@ private function finishSetup(): void {
 		\OC::$server->getIntegrityCodeChecker()->runInstanceVerification();
 
 		if ($this->setupHelper->shouldRemoveCanInstallFile()) {
-			\OC_Template::printGuestPage('', 'installation_incomplete');
+			$this->templateManager->printGuestPage('', 'installation_incomplete');
 		}
 
 		header('Location: ' . \OC::$server->getURLGenerator()->getAbsoluteURL('index.php/core/apps/recommended'));

Diff for: index.php

@@ -16,6 +16,7 @@
 use OCP\IRequest;
 use OCP\Security\Bruteforce\MaxDelayReached;
 use OCP\Server;
+use OCP\Template\ITemplateManager;
 use Psr\Log\LoggerInterface;
 
 try {
@@ -29,10 +30,10 @@
 	]);
 
 	//show the user a detailed error page
-	OC_Template::printExceptionErrorPage($ex, 503);
+	Server::get(ITemplateManager::class)->printExceptionErrorPage($ex, 503);
 } catch (HintException $ex) {
 	try {
-		OC_Template::printErrorPage($ex->getMessage(), $ex->getHint(), 503);
+		Server::get(ITemplateManager::class)->printErrorPage($ex->getMessage(), $ex->getHint(), 503);
 	} catch (Exception $ex2) {
 		try {
 			Server::get(LoggerInterface::class)->error($ex->getMessage(), [
@@ -48,7 +49,7 @@
 		}
 
 		//show the user a detailed error page
-		OC_Template::printExceptionErrorPage($ex, 500);
+		Server::get(ITemplateManager::class)->printExceptionErrorPage($ex, 500);
 	}
 } catch (LoginException $ex) {
 	$request = Server::get(IRequest::class);
@@ -63,7 +64,7 @@
 		echo json_encode(['message' => $ex->getMessage()]);
 		exit();
 	}
-	OC_Template::printErrorPage($ex->getMessage(), $ex->getMessage(), 401);
+	Server::get(ITemplateManager::class)->printErrorPage($ex->getMessage(), $ex->getMessage(), 401);
 } catch (MaxDelayReached $ex) {
 	$request = Server::get(IRequest::class);
 	/**
@@ -78,15 +79,15 @@
 		exit();
 	}
 	http_response_code(429);
-	OC_Template::printGuestPage('core', '429');
+	Server::get(ITemplateManager::class)->printGuestPage('core', '429');
 } catch (Exception $ex) {
 	Server::get(LoggerInterface::class)->error($ex->getMessage(), [
 		'app' => 'index',
 		'exception' => $ex,
 	]);
 
 	//show the user a detailed error page
-	OC_Template::printExceptionErrorPage($ex, 500);
+	Server::get(ITemplateManager::class)->printExceptionErrorPage($ex, 500);
 } catch (Error $ex) {
 	try {
 		Server::get(LoggerInterface::class)->error($ex->getMessage(), [
@@ -103,5 +104,5 @@
 
 		throw $ex;
 	}
-	OC_Template::printExceptionErrorPage($ex, 500);
+	Server::get(ITemplateManager::class)->printExceptionErrorPage($ex, 500);
 }

Diff for: lib/base.php

@@ -21,6 +21,7 @@
 use OCP\Security\Bruteforce\IThrottler;
 use OCP\Server;
 use OCP\Share;
+use OCP\Template\ITemplateManager;
 use OCP\User\Events\UserChangedEvent;
 use OCP\User\Events\UserDeletedEvent;
 use OCP\Util;
@@ -208,7 +209,7 @@ public static function checkConfig(): void {
 				echo $l->t('See %s', [ $urlGenerator->linkToDocs('admin-config') ]) . "\n";
 				exit;
 			} else {
-				OC_Template::printErrorPage(
+				Server::get(ITemplateManager::class)->printErrorPage(
 					$l->t('Cannot write into "config" directory!'),
 					$l->t('This can usually be fixed by giving the web server write access to the config directory.') . ' '
 					. $l->t('But, if you prefer to keep config.php file read only, set the option "config_is_read_only" to true in it.') . ' '
@@ -244,7 +245,7 @@ public static function checkMaintenanceMode(\OC\SystemConfig $systemConfig): voi
 			header('Retry-After: 120');
 
 			// render error page
-			$template = new OC_Template('', 'update.user', 'guest');
+			$template = Server::get(ITemplateManager::class)->getTemplate('', 'update.user', 'guest');
 			\OCP\Util::addScript('core', 'maintenance');
 			\OCP\Util::addStyle('core', 'guest');
 			$template->printPage();
@@ -300,7 +301,7 @@ private static function printUpgradePage(\OC\SystemConfig $systemConfig): void {
 			$serverVersion = \OCP\Server::get(\OCP\ServerVersion::class);
 
 			// render error page
-			$template = new OC_Template('', 'update.use-cli', 'guest');
+			$template = Server::get(ITemplateManager::class)->getTemplate('', 'update.use-cli', 'guest');
 			$template->assign('productName', 'nextcloud'); // for now
 			$template->assign('version', $serverVersion->getVersionString());
 			$template->assign('tooBig', $tooBig);
@@ -327,7 +328,7 @@ private static function printUpgradePage(\OC\SystemConfig $systemConfig): void {
 		/** @var \OC\App\AppManager $appManager */
 		$appManager = Server::get(\OCP\App\IAppManager::class);
 
-		$tmpl = new OC_Template('', 'update.admin', 'guest');
+		$tmpl = Server::get(ITemplateManager::class)->getTemplate('', 'update.admin', 'guest');
 		$tmpl->assign('version', \OCP\Server::get(\OCP\ServerVersion::class)->getVersionString());
 		$tmpl->assign('isAppsOnlyUpgrade', $isAppsOnlyUpgrade);
 
@@ -420,7 +421,7 @@ public static function initSession(): void {
 		} catch (Exception $e) {
 			Server::get(LoggerInterface::class)->error($e->getMessage(), ['app' => 'base','exception' => $e]);
 			//show the user a detailed error page
-			OC_Template::printExceptionErrorPage($e, 500);
+			Server::get(ITemplateManager::class)->printExceptionErrorPage($e, 500);
 			die();
 		}
 
@@ -659,7 +660,7 @@ public static function init(): void {
 			if ($config->getSystemValueBool('debug', false)) {
 				set_error_handler([$errorHandler, 'onAll'], E_ALL);
 				if (\OC::$CLI) {
-					$exceptionHandler = ['OC_Template', 'printExceptionErrorPage'];
+					$exceptionHandler = [Server::get(ITemplateManager::class), 'printExceptionErrorPage'];
 				}
 			} else {
 				set_error_handler([$errorHandler, 'onError']);
@@ -702,7 +703,7 @@ public static function init(): void {
 					http_response_code(503);
 					OC_Util::addStyle('guest');
 					try {
-						OC_Template::printGuestPage('', 'error', ['errors' => $errors]);
+						Server::get(ITemplateManager::class)->printGuestPage('', 'error', ['errors' => $errors]);
 						exit;
 					} catch (\Exception $e) {
 						// In case any error happens when showing the error page, we simply fall back to posting the text.
@@ -781,7 +782,7 @@ public static function init(): void {
 		// Check whether the sample configuration has been copied
 		if ($systemConfig->getValue('copied_sample_config', false)) {
 			$l = Server::get(\OCP\L10N\IFactory::class)->get('lib');
-			OC_Template::printErrorPage(
+			Server::get(ITemplateManager::class)->printErrorPage(
 				$l->t('Sample configuration detected'),
 				$l->t('It has been detected that the sample configuration has been copied. This can break your installation and is unsupported. Please read the documentation before performing changes on config.php'),
 				503
@@ -1094,7 +1095,7 @@ public static function handleRequest(): void {
 				logger('core')->emergency($e->getMessage(), ['exception' => $e]);
 			}
 			$l = Server::get(\OCP\L10N\IFactory::class)->get('lib');
-			OC_Template::printErrorPage(
+			Server::get(ITemplateManager::class)->printErrorPage(
 				'404',
 				$l->t('The page could not be found on the server.'),
 				404

Diff for: lib/private/Template/Base.php

@@ -12,7 +12,7 @@
 
 class Base {
 	private $template; // The template
-	private $vars; // Vars
+	private array $vars = [];
 
 	/** @var \OCP\IL10N */
 	private $l10n;
@@ -59,11 +59,9 @@ protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
 	}
 
 	/**
-	 * @param string $serverRoot
-	 * @param string $theme
 	 * @return string[]
 	 */
-	protected function getCoreTemplateDirs($theme, $serverRoot) {
+	protected function getCoreTemplateDirs(string $theme, string $serverRoot): array {
 		return [
 			$serverRoot . '/themes/' . $theme . '/core/templates/',
 			$serverRoot . '/core/templates/',
@@ -105,42 +103,29 @@ public function append($key, $value) {
 
 	/**
 	 * Prints the proceeded template
-	 * @return bool
 	 *
 	 * This function proceeds the template and prints its output.
 	 */
-	public function printPage() {
+	public function printPage(): void {
 		$data = $this->fetchPage();
-		if ($data === false) {
-			return false;
-		} else {
-			print $data;
-			return true;
-		}
+		print $data;
 	}
 
 	/**
 	 * Process the template
 	 *
-	 * @param array|null $additionalParams
-	 * @return string This function processes the template.
-	 *
 	 * This function processes the template.
 	 */
-	public function fetchPage($additionalParams = null) {
+	public function fetchPage(?array $additionalParams = null): string {
 		return $this->load($this->template, $additionalParams);
 	}
 
 	/**
 	 * doing the actual work
 	 *
-	 * @param string $file
-	 * @param array|null $additionalParams
-	 * @return string content
-	 *
 	 * Includes the template file, fetches its output
 	 */
-	protected function load($file, $additionalParams = null) {
+	protected function load(string $file, ?array $additionalParams = null): string {
 		// Register the variables
 		$_ = $this->vars;
 		$l = $this->l10n;