Merge pull request #51838 from nextcloud/feat/cleanup-oc-util-methods

Mark all methods of OC_Util as deprecated

Author: skjnldsv

apps/settings/templates/help.php

@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-\OC_Util::addStyle('settings', 'help');
+\OCP\Util::addStyle('settings', 'help');
 ?>
 <?php if ($_['knowledgebaseEmbedded'] === true) : ?>
 	<div id="app-navigation" role="navigation" tabindex="0">

build/psalm-baseline.xml

@@ -2607,11 +2607,6 @@
       <code><![CDATA[\Test\Util\User\Dummy]]></code>
     </UndefinedClass>
   </file>
-  <file src="lib/private/legacy/OC_Util.php">
-    <InvalidReturnType>
-      <code><![CDATA[void]]></code>
-    </InvalidReturnType>
-  </file>
   <file src="lib/public/AppFramework/ApiController.php">
     <NoInterfaceProperties>
       <code><![CDATA[$this->request->server]]></code>

core/Listener/BeforeTemplateRenderedListener.php

@@ -37,7 +37,7 @@ public function handle(Event $event): void {
 			Util::addScript('core', 'public');
 		}
 
-		\OC_Util::addStyle('server', null, true);
+		Util::addStyle('server', null, true);
 
 		if ($event instanceof BeforeLoginTemplateRenderedEvent) {
 			// todo: make login work without these

core/js/tests/specs/coreSpec.js

@@ -359,7 +359,7 @@ describe('Core base tests', function() {
 		// to make sure they run.
 		var cit = window.isPhantom?xit:it;
 
-		// must provide the same results as \OC_Util::naturalSortCompare
+		// must provide the same results as \OCP\Util::naturalSortCompare
 		it('sorts alphabetically', function() {
 			var a = [
 				'def',

cypress/e2e/settings/users.cy.ts

@@ -115,12 +115,13 @@ describe('Settings: Create and delete accounts', function() {
 
 			// The "Delete account" action in the actions menu is shown and clicked
 			cy.get('.action-item__popper .action').contains('Delete account').should('exist').click({ force: true })
-			// And confirmation dialog accepted
-			cy.get('.nc-generic-dialog button').contains(`Delete ${testUser.userId}`).click({ force: true })
 
 			// Make sure no confirmation modal is shown
 			handlePasswordConfirmation(admin.password)
 
+			// And confirmation dialog accepted
+			cy.get('.nc-generic-dialog button').contains(`Delete ${testUser.userId}`).click({ force: true })
+
 			// deleted clicked the user is not shown anymore
 			getUserListRow(testUser.userId).should('not.exist')
 		})

lib/base.php

@@ -704,7 +704,7 @@ public static function init(): void {
 			if (count($errors) > 0) {
 				if (!self::$CLI) {
 					http_response_code(503);
-					OC_Util::addStyle('guest');
+					Util::addStyle('guest');
 					try {
 						Server::get(ITemplateManager::class)->printGuestPage('', 'error', ['errors' => $errors]);
 						exit;

lib/private/Image.php

@@ -56,7 +56,7 @@ public function __construct(
 		$this->appConfig = $appConfig ?? Server::get(IAppConfig::class);
 		$this->config = $config ?? Server::get(IConfig::class);
 
-		if (\OC_Util::fileInfoLoaded()) {
+		if (class_exists(finfo::class)) {
 			$this->fileInfo = new finfo(FILEINFO_MIME_TYPE);
 		}
 	}

lib/private/Setup.php

@@ -21,12 +21,14 @@
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\Defaults;
+use OCP\Http\Client\IClientService;
 use OCP\IAppConfig;
 use OCP\IConfig;
 use OCP\IGroup;
 use OCP\IGroupManager;
 use OCP\IL10N;
 use OCP\IRequest;
+use OCP\IURLGenerator;
 use OCP\IUserManager;
 use OCP\IUserSession;
 use OCP\L10N\IFactory as IL10NFactory;
@@ -170,8 +172,7 @@ public function getSystemInfo(bool $allowAllDatabases = false): array {
 			self::protectDataDirectory();
 
 			try {
-				$util = new \OC_Util();
-				$htAccessWorking = $util->isHtaccessWorking(Server::get(IConfig::class));
+				$htAccessWorking = $this->isHtaccessWorking($dataDir);
 			} catch (\OCP\HintException $e) {
 				$errors[] = [
 					'error' => $e->getMessage(),
@@ -212,6 +213,87 @@ public function getSystemInfo(bool $allowAllDatabases = false): array {
 		];
 	}
 
+	public function createHtaccessTestFile(string $dataDir): string|false {
+		// php dev server does not support htaccess
+		if (php_sapi_name() === 'cli-server') {
+			return false;
+		}
+
+		// testdata
+		$fileName = '/htaccesstest.txt';
+		$testContent = 'This is used for testing whether htaccess is properly enabled to disallow access from the outside. This file can be safely removed.';
+
+		// creating a test file
+		$testFile = $dataDir . '/' . $fileName;
+
+		if (file_exists($testFile)) {// already running this test, possible recursive call
+			return false;
+		}
+
+		$fp = @fopen($testFile, 'w');
+		if (!$fp) {
+			throw new \OCP\HintException('Can\'t create test file to check for working .htaccess file.',
+				'Make sure it is possible for the web server to write to ' . $testFile);
+		}
+		fwrite($fp, $testContent);
+		fclose($fp);
+
+		return $testContent;
+	}
+
+	/**
+	 * Check if the .htaccess file is working
+	 *
+	 * @param \OCP\IConfig $config
+	 * @return bool
+	 * @throws Exception
+	 * @throws \OCP\HintException If the test file can't get written.
+	 */
+	public function isHtaccessWorking(string $dataDir) {
+		$config = Server::get(IConfig::class);
+
+		if (\OC::$CLI || !$config->getSystemValueBool('check_for_working_htaccess', true)) {
+			return true;
+		}
+
+		$testContent = $this->createHtaccessTestFile($dataDir);
+		if ($testContent === false) {
+			return false;
+		}
+
+		$fileName = '/htaccesstest.txt';
+		$testFile = $dataDir . '/' . $fileName;
+
+		// accessing the file via http
+		$url = Server::get(IURLGenerator::class)->getAbsoluteURL(\OC::$WEBROOT . '/data' . $fileName);
+		try {
+			$content = Server::get(IClientService::class)->newClient()->get($url)->getBody();
+		} catch (\Exception $e) {
+			$content = false;
+		}
+
+		if (str_starts_with($url, 'https:')) {
+			$url = 'http:' . substr($url, 6);
+		} else {
+			$url = 'https:' . substr($url, 5);
+		}
+
+		try {
+			$fallbackContent = Server::get(IClientService::class)->newClient()->get($url)->getBody();
+		} catch (\Exception $e) {
+			$fallbackContent = false;
+		}
+
+		// cleanup
+		@unlink($testFile);
+
+		/*
+		 * If the content is not equal to test content our .htaccess
+		 * is working as required
+		 */
+		return $content !== $testContent && $fallbackContent !== $testContent;
+	}
+
 	/**
 	 * @return array<string|array> errors
 	 */

lib/private/Share20/Manager.php

@@ -1970,14 +1970,9 @@ public function currentUserCanEnumerateTargetUser(?IUser $currentUser, IUser $ta
 	}
 
 	/**
-	 * Copied from \OC_Util::isSharingDisabledForUser
-	 *
-	 * TODO: Deprecate function from OC_Util
-	 *
-	 * @param string $userId
-	 * @return bool
+	 * Check if sharing is disabled for the current user
 	 */
-	public function sharingDisabledForUser($userId) {
+	public function sharingDisabledForUser(?string $userId): bool {
 		return $this->shareDisableChecker->sharingDisabledForUser($userId);
 	}
 

lib/private/Share20/ShareDisableChecker.php

@@ -25,12 +25,7 @@ public function __construct(
 		$this->sharingDisabledForUsersCache = new CappedMemoryCache();
 	}
 
-
-	/**
-	 * @param ?string $userId
-	 * @return bool
-	 */
-	public function sharingDisabledForUser(?string $userId) {
+	public function sharingDisabledForUser(?string $userId): bool {
 		if ($userId === null) {
 			return false;
 		}