Merge pull request #44730 from nextcloud/jail-watcher

fix: use proper jailed patch in watcher

Author: icewind1991

lib/composer/composer/autoload_classmap.php

@@ -1383,6 +1383,7 @@
     'OC\\Files\\Cache\\Wrapper\\CachePermissionsMask' => $baseDir . '/lib/private/Files/Cache/Wrapper/CachePermissionsMask.php',
     'OC\\Files\\Cache\\Wrapper\\CacheWrapper' => $baseDir . '/lib/private/Files/Cache/Wrapper/CacheWrapper.php',
     'OC\\Files\\Cache\\Wrapper\\JailPropagator' => $baseDir . '/lib/private/Files/Cache/Wrapper/JailPropagator.php',
+    'OC\\Files\\Cache\\Wrapper\\JailWatcher' => $baseDir . '/lib/private/Files/Cache/Wrapper/JailWatcher.php',
     'OC\\Files\\Config\\CachedMountFileInfo' => $baseDir . '/lib/private/Files/Config/CachedMountFileInfo.php',
     'OC\\Files\\Config\\CachedMountInfo' => $baseDir . '/lib/private/Files/Config/CachedMountInfo.php',
     'OC\\Files\\Config\\LazyPathCachedMountInfo' => $baseDir . '/lib/private/Files/Config/LazyPathCachedMountInfo.php',

lib/composer/composer/autoload_static.php

@@ -1416,6 +1416,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Files\\Cache\\Wrapper\\CachePermissionsMask' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/Wrapper/CachePermissionsMask.php',
         'OC\\Files\\Cache\\Wrapper\\CacheWrapper' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/Wrapper/CacheWrapper.php',
         'OC\\Files\\Cache\\Wrapper\\JailPropagator' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/Wrapper/JailPropagator.php',
+        'OC\\Files\\Cache\\Wrapper\\JailWatcher' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/Wrapper/JailWatcher.php',
         'OC\\Files\\Config\\CachedMountFileInfo' => __DIR__ . '/../../..' . '/lib/private/Files/Config/CachedMountFileInfo.php',
         'OC\\Files\\Config\\CachedMountInfo' => __DIR__ . '/../../..' . '/lib/private/Files/Config/CachedMountInfo.php',
         'OC\\Files\\Config\\LazyPathCachedMountInfo' => __DIR__ . '/../../..' . '/lib/private/Files/Config/LazyPathCachedMountInfo.php',

lib/private/Files/Cache/Wrapper/JailWatcher.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2024 Robin Appelman <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Files\Cache\Wrapper;
+
+use OC\Files\Cache\Watcher;
+
+class JailWatcher extends Watcher {
+	private string $root;
+	private Watcher $watcher;
+
+	public function __construct(Watcher $watcher, string $root) {
+		$this->watcher = $watcher;
+		$this->root = $root;
+	}
+
+	protected function getRoot(): string {
+		return $this->root;
+	}
+
+	protected function getSourcePath($path): string {
+		if ($path === '') {
+			return $this->getRoot();
+		} else {
+			return $this->getRoot() . '/' . ltrim($path, '/');
+		}
+	}
+
+	public function setPolicy($policy) {
+		$this->watcher->setPolicy($policy);
+	}
+
+	public function getPolicy() {
+		return $this->watcher->getPolicy();
+	}
+
+
+	public function checkUpdate($path, $cachedEntry = null) {
+		return $this->watcher->checkUpdate($this->getSourcePath($path), $cachedEntry);
+	}
+
+	public function update($path, $cachedData) {
+		$this->watcher->update($this->getSourcePath($path), $cachedData);
+	}
+
+	public function needsUpdate($path, $cachedData) {
+		return $this->watcher->needsUpdate($this->getSourcePath($path), $cachedData);
+	}
+
+	public function cleanFolder($path) {
+		$this->watcher->cleanFolder($this->getSourcePath($path));
+	}
+
+}

lib/private/Files/Storage/Wrapper/Jail.php

@@ -30,6 +30,7 @@
 
 use OC\Files\Cache\Wrapper\CacheJail;
 use OC\Files\Cache\Wrapper\JailPropagator;
+use OC\Files\Cache\Wrapper\JailWatcher;
 use OC\Files\Filesystem;
 use OCP\Files\Storage\IStorage;
 use OCP\Files\Storage\IWriteStreamStorage;
@@ -418,10 +419,8 @@ public function getOwner($path) {
 	 * @return \OC\Files\Cache\Watcher
 	 */
 	public function getWatcher($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return $this->getWrapperStorage()->getWatcher($this->getUnjailedPath($path), $storage);
+		$sourceWatcher = $this->getWrapperStorage()->getWatcher($this->getUnjailedPath($path), $this->getWrapperStorage());
+		return new JailWatcher($sourceWatcher, $this->rootPath);
 	}
 
 	/**

tests/lib/Files/Cache/Wrapper/CacheJailTest.php

@@ -11,6 +11,7 @@
 use OC\Files\Cache\Wrapper\CacheJail;
 use OC\Files\Search\SearchComparison;
 use OC\Files\Search\SearchQuery;
+use OC\Files\Storage\Wrapper\Jail;
 use OC\User\User;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Search\ISearchComparison;
@@ -218,4 +219,33 @@ public function testRootJail() {
 		$this->assertCount(1, $result);
 		$this->assertEquals('foo/bar/asd', $result[0]['path']);
 	}
+
+	public function testWatcher() {
+		$storage = new Jail([
+			'storage' => $this->storage,
+			'root' => 'foo'
+		]);
+		$storage->getScanner()->scan('');
+		$storage->file_put_contents('bar', 'asd');
+
+		$this->assertFalse($this->cache->inCache('bar'));
+		$storage->getWatcher()->update('bar', ['mimetype' => 'text/plain']);
+		$this->assertTrue($this->cache->inCache('bar'));
+	}
+
+	public function testWatcherAfterInnerWatcher() {
+		$storage = new Jail([
+			'storage' => $this->storage,
+			'root' => 'foo'
+		]);
+		$storage->getScanner()->scan('');
+		$storage->file_put_contents('bar', 'asd');
+
+		// let the underlying storage create it's watcher first
+		$this->storage->getWatcher();
+
+		$this->assertFalse($this->cache->inCache('bar'));
+		$storage->getWatcher()->update('bar', ['mimetype' => 'text/plain']);
+		$this->assertTrue($this->cache->inCache('bar'));
+	}
 }