fixup! fix(Share20\Manager): Explicitly setup the filesystem for the user

Signed-off-by: provokateurin <kate@provokateurin.de>

apps/files_sharing/tests/TestCase.php

@@ -193,6 +193,7 @@ abstract class TestCase extends \Test\TestCase {
 		Server::get(IUserSession::class)->setUser(null);
 		Filesystem::tearDown();
 		Server::get(IUserSession::class)->login($user, $password);
+		Filesystem::initMountPoints($user);
 		\OC::$server->getUserFolder($user);
 
 		\OC_Util::setupFS($user);

build/psalm-baseline.xml

@@ -3265,12 +3265,6 @@
       <code><![CDATA[$this->providers]]></code>
     </UndefinedInterfaceMethod>
   </file>
-  <file src="lib/private/Cache/File.php">
-    <LessSpecificImplementedReturnType>
-      <code><![CDATA[bool|mixed]]></code>
-      <code><![CDATA[bool|mixed]]></code>
-    </LessSpecificImplementedReturnType>
-  </file>
   <file src="lib/private/Calendar/Manager.php">
     <LessSpecificReturnStatement>
       <code><![CDATA[array_merge(

lib/base.php

@@ -977,23 +977,6 @@ class OC {
 					$throttler = Server::get(IThrottler::class);
 					$throttler->resetDelay($request->getRemoteAddress(), 'login', ['user' => $uid]);
 				}
-
-				try {
-					$cache = new \OC\Cache\File();
-					$cache->gc();
-				} catch (\OC\ServerNotAvailableException $e) {
-					// not a GC exception, pass it on
-					throw $e;
-				} catch (\OC\ForbiddenException $e) {
-					// filesystem blocked for this request, ignore
-				} catch (\Exception $e) {
-					// a GC exception should not prevent users from using OC,
-					// so log the exception
-					Server::get(LoggerInterface::class)->warning('Exception when running cache gc.', [
-						'app' => 'core',
-						'exception' => $e,
-					]);
-				}
 			});
 		}
 	}

lib/composer/composer/autoload_classmap.php

@@ -1247,7 +1247,6 @@ return array(
     'OC\\BinaryFinder' => $baseDir . '/lib/private/BinaryFinder.php',
     'OC\\Blurhash\\Listener\\GenerateBlurhashMetadata' => $baseDir . '/lib/private/Blurhash/Listener/GenerateBlurhashMetadata.php',
     'OC\\Broadcast\\Events\\BroadcastEvent' => $baseDir . '/lib/private/Broadcast/Events/BroadcastEvent.php',
-    'OC\\Cache\\File' => $baseDir . '/lib/private/Cache/File.php',
     'OC\\Calendar\\AvailabilityResult' => $baseDir . '/lib/private/Calendar/AvailabilityResult.php',
     'OC\\Calendar\\CalendarEventBuilder' => $baseDir . '/lib/private/Calendar/CalendarEventBuilder.php',
     'OC\\Calendar\\CalendarQuery' => $baseDir . '/lib/private/Calendar/CalendarQuery.php',

lib/composer/composer/autoload_static.php

@@ -1288,7 +1288,6 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\BinaryFinder' => __DIR__ . '/../../..' . '/lib/private/BinaryFinder.php',
         'OC\\Blurhash\\Listener\\GenerateBlurhashMetadata' => __DIR__ . '/../../..' . '/lib/private/Blurhash/Listener/GenerateBlurhashMetadata.php',
         'OC\\Broadcast\\Events\\BroadcastEvent' => __DIR__ . '/../../..' . '/lib/private/Broadcast/Events/BroadcastEvent.php',
-        'OC\\Cache\\File' => __DIR__ . '/../../..' . '/lib/private/Cache/File.php',
         'OC\\Calendar\\AvailabilityResult' => __DIR__ . '/../../..' . '/lib/private/Calendar/AvailabilityResult.php',
         'OC\\Calendar\\CalendarEventBuilder' => __DIR__ . '/../../..' . '/lib/private/Calendar/CalendarEventBuilder.php',
         'OC\\Calendar\\CalendarQuery' => __DIR__ . '/../../..' . '/lib/private/Calendar/CalendarQuery.php',

lib/private/Cache/File.php

@@ -1,194 +0,0 @@
-<?php
-
-/**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-namespace OC\Cache;
-
-use OC\Files\Filesystem;
-use OC\Files\View;
-use OC\ForbiddenException;
-use OC\User\NoUserException;
-use OCP\Files\LockNotAcquiredException;
-use OCP\ICache;
-use OCP\IUserSession;
-use OCP\Lock\LockedException;
-use OCP\Security\ISecureRandom;
-use OCP\Server;
-use Psr\Log\LoggerInterface;
-
-class File implements ICache {
-	/** @var View */
-	protected $storage;
-
-	/**
-	 * Returns the cache storage for the logged in user
-	 *
-	 * @return View cache storage
-	 * @throws ForbiddenException
-	 * @throws NoUserException
-	 */
-	protected function getStorage() {
-		if ($this->storage !== null) {
-			return $this->storage;
-		}
-		$session = Server::get(IUserSession::class);
-		if ($session->isLoggedIn()) {
-			$rootView = new View();
-			$userId = $session->getUser()->getUID();
-			Filesystem::initMountPoints($userId);
-			if (!$rootView->file_exists('/' . $userId . '/cache')) {
-				$rootView->mkdir('/' . $userId . '/cache');
-			}
-			$this->storage = new View('/' . $userId . '/cache');
-			return $this->storage;
-		} else {
-			Server::get(LoggerInterface::class)->error('Can\'t get cache storage, user not logged in', ['app' => 'core']);
-			throw new ForbiddenException('Can\t get cache storage, user not logged in');
-		}
-	}
-
-	/**
-	 * @param string $key
-	 * @return mixed|null
-	 * @throws ForbiddenException
-	 */
-	public function get($key) {
-		$result = null;
-		if ($this->hasKey($key)) {
-			$storage = $this->getStorage();
-			$result = $storage->file_get_contents($key);
-		}
-		return $result;
-	}
-
-	/**
-	 * Returns the size of the stored/cached data
-	 *
-	 * @param string $key
-	 * @return int
-	 */
-	public function size($key) {
-		$result = 0;
-		if ($this->hasKey($key)) {
-			$storage = $this->getStorage();
-			$result = $storage->filesize($key);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl
-	 * @return bool|mixed
-	 * @throws ForbiddenException
-	 */
-	public function set($key, $value, $ttl = 0) {
-		$storage = $this->getStorage();
-		$result = false;
-		// unique id to avoid chunk collision, just in case
-		$uniqueId = Server::get(ISecureRandom::class)->generate(
-			16,
-			ISecureRandom::CHAR_ALPHANUMERIC
-		);
-
-		// use part file to prevent hasKey() to find the key
-		// while it is being written
-		$keyPart = $key . '.' . $uniqueId . '.part';
-		if ($storage && $storage->file_put_contents($keyPart, $value)) {
-			if ($ttl === 0) {
-				$ttl = 86400; // 60*60*24
-			}
-			$result = $storage->touch($keyPart, time() + $ttl);
-			$result &= $storage->rename($keyPart, $key);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string $key
-	 * @return bool
-	 * @throws ForbiddenException
-	 */
-	public function hasKey($key) {
-		$storage = $this->getStorage();
-		if ($storage && $storage->is_file($key) && $storage->isReadable($key)) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $key
-	 * @return bool|mixed
-	 * @throws ForbiddenException
-	 */
-	public function remove($key) {
-		$storage = $this->getStorage();
-		if (!$storage) {
-			return false;
-		}
-		return $storage->unlink($key);
-	}
-
-	/**
-	 * @param string $prefix
-	 * @return bool
-	 * @throws ForbiddenException
-	 */
-	public function clear($prefix = '') {
-		$storage = $this->getStorage();
-		if ($storage && $storage->is_dir('/')) {
-			$dh = $storage->opendir('/');
-			if (is_resource($dh)) {
-				while (($file = readdir($dh)) !== false) {
-					if ($file !== '.' && $file !== '..' && ($prefix === '' || str_starts_with($file, $prefix))) {
-						$storage->unlink('/' . $file);
-					}
-				}
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * Runs GC
-	 * @throws ForbiddenException
-	 */
-	public function gc() {
-		$storage = $this->getStorage();
-		if ($storage) {
-			$ttl = \OC::$server->getConfig()->getSystemValueInt('cache_chunk_gc_ttl', 60 * 60 * 24);
-			$now = time() - $ttl;
-
-			$dh = $storage->opendir('/');
-			if (!is_resource($dh)) {
-				return null;
-			}
-			while (($file = readdir($dh)) !== false) {
-				if ($file !== '.' && $file !== '..') {
-					try {
-						$mtime = $storage->filemtime('/' . $file);
-						if ($mtime < $now) {
-							$storage->unlink('/' . $file);
-						}
-					} catch (LockedException $e) {
-						// ignore locked chunks
-						Server::get(LoggerInterface::class)->debug('Could not cleanup locked chunk "' . $file . '"', ['app' => 'core']);
-					} catch (\OCP\Files\ForbiddenException $e) {
-						Server::get(LoggerInterface::class)->debug('Could not cleanup forbidden chunk "' . $file . '"', ['app' => 'core']);
-					} catch (LockNotAcquiredException $e) {
-						Server::get(LoggerInterface::class)->debug('Could not cleanup locked chunk "' . $file . '"', ['app' => 'core']);
-					}
-				}
-			}
-		}
-	}
-
-	public static function isAvailable(): bool {
-		return true;
-	}
-}

lib/private/Server.php

@@ -619,7 +619,16 @@ class Server extends ServerContainer implements IServerContainer {
 
 		$this->registerAlias(IURLGenerator::class, URLGenerator::class);
 
-		$this->registerAlias(ICache::class, Cache\File::class);
+		$this->registerService(ICache::class, function ($c) {
+			/** @var LoggerInterface $logger */
+			$logger = $c->get(LoggerInterface::class);
+			$logger->debug('The requested service "' . ICache::class . '" is deprecated. Please use "' . ICacheFactory::class . '" instead to create a cache. This service will be removed in a future Nextcloud version.', ['app' => 'serverDI']);
+
+			/** @var ICacheFactory $cacheFactory */
+			$cacheFactory = $c->get(ICacheFactory::class);
+			return $cacheFactory->isLocalCacheAvailable() ? $cacheFactory->createLocal() : $cacheFactory->createInMemory();
+		});
+
 		$this->registerService(Factory::class, function (Server $c) {
 			$profiler = $c->get(IProfiler::class);
 			$logger = $c->get(LoggerInterface::class);

tests/lib/Cache/FileCacheTest.php

@@ -1,161 +0,0 @@
-<?php
-
-/**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
-
-namespace Test\Cache;
-
-use OC\Cache\File;
-use OC\Files\Filesystem;
-use OC\Files\Storage\Local;
-use OC\Files\Storage\Storage;
-use OC\Files\Storage\Temporary;
-use OC\Files\View;
-use OCP\Files\LockNotAcquiredException;
-use OCP\Files\Mount\IMountManager;
-use OCP\ITempManager;
-use OCP\Lock\LockedException;
-use OCP\Server;
-use Test\Traits\UserTrait;
-
-/**
- * Class FileCacheTest
- *
- *
- * @package Test\Cache
- */
-#[\PHPUnit\Framework\Attributes\Group('DB')]
-class FileCacheTest extends TestCache {
-	use UserTrait;
-
-	/**
-	 * @var string
-	 * */
-	private $user;
-	/**
-	 * @var string
-	 * */
-	private $datadir;
-	/**
-	 * @var Storage
-	 * */
-	private $storage;
-	/**
-	 * @var View
-	 * */
-	private $rootView;
-
-	public function skip() {
-		//$this->skipUnless(OC_User::isLoggedIn());
-	}
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		//login
-		$this->createUser('test', 'test');
-
-		$this->user = \OC_User::getUser();
-		\OC_User::setUserId('test');
-
-		//clear all proxies and hooks so we can do clean testing
-		\OC_Hook::clear('OC_Filesystem');
-
-		/** @var IMountManager $manager */
-		$manager = Server::get(IMountManager::class);
-		$manager->removeMount('/test');
-
-		$storage = new Temporary([]);
-		Filesystem::mount($storage, [], '/test/cache');
-
-		//set up the users dir
-		$this->rootView = new View('');
-		$this->rootView->mkdir('/test');
-
-		$this->instance = new File();
-
-		// forces creation of cache folder for subsequent tests
-		$this->instance->set('hack', 'hack');
-	}
-
-	protected function tearDown(): void {
-		if ($this->instance) {
-			$this->instance->remove('hack', 'hack');
-		}
-
-		\OC_User::setUserId($this->user);
-
-		if ($this->instance) {
-			$this->instance->clear();
-			$this->instance = null;
-		}
-
-		parent::tearDown();
-	}
-
-	private function setupMockStorage() {
-		$mockStorage = $this->getMockBuilder(Local::class)
-			->onlyMethods(['filemtime', 'unlink'])
-			->setConstructorArgs([['datadir' => Server::get(ITempManager::class)->getTemporaryFolder()]])
-			->getMock();
-
-		Filesystem::mount($mockStorage, [], '/test/cache');
-
-		return $mockStorage;
-	}
-
-	public function testGarbageCollectOldKeys(): void {
-		$mockStorage = $this->setupMockStorage();
-
-		$mockStorage->expects($this->atLeastOnce())
-			->method('filemtime')
-			->willReturn(100);
-		$mockStorage->expects($this->once())
-			->method('unlink')
-			->with('key1')
-			->willReturn(true);
-
-		$this->instance->set('key1', 'value1');
-		$this->instance->gc();
-	}
-
-	public function testGarbageCollectLeaveRecentKeys(): void {
-		$mockStorage = $this->setupMockStorage();
-
-		$mockStorage->expects($this->atLeastOnce())
-			->method('filemtime')
-			->willReturn(time() + 3600);
-		$mockStorage->expects($this->never())
-			->method('unlink')
-			->with('key1');
-		$this->instance->set('key1', 'value1');
-		$this->instance->gc();
-	}
-
-	public static function lockExceptionProvider(): array {
-		return [
-			[new LockedException('key1')],
-			[new LockNotAcquiredException('key1', 1)],
-		];
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('lockExceptionProvider')]
-	public function testGarbageCollectIgnoreLockedKeys($testException): void {
-		$mockStorage = $this->setupMockStorage();
-
-		$mockStorage->expects($this->atLeastOnce())
-			->method('filemtime')
-			->willReturn(100);
-		$mockStorage->expects($this->atLeastOnce())
-			->method('unlink')
-			->willReturnOnConsecutiveCalls($this->throwException($testException), true);
-
-		$this->instance->set('key1', 'value1');
-		$this->instance->set('key2', 'value2');
-
-		$this->instance->gc();
-	}
-}