feat(encryption): Migrate from hooks to events

apps/admin_audit/lib/Actions/Files.php

@@ -10,7 +10,6 @@
 use OC\Files\Node\NonExistingFile;
 use OCP\Files\Events\Node\BeforeNodeDeletedEvent;
 use OCP\Files\Events\Node\BeforeNodeReadEvent;
-use OCP\Files\Events\Node\BeforeNodeRenamedEvent;
 use OCP\Files\Events\Node\NodeCopiedEvent;
 use OCP\Files\Events\Node\NodeCreatedEvent;
 use OCP\Files\Events\Node\NodeRenamedEvent;
@@ -26,9 +25,6 @@
  * @package OCA\AdminAudit\Actions
  */
 class Files extends Action {
-
-	private array $renamedNodes = [];
-
 	/**
 	 * Logs file read actions
 	 */
@@ -52,31 +48,16 @@ public function read(BeforeNodeReadEvent $event): void {
 		);
 	}
 
-	/**
-	 * Logs rename actions of files
-	 */
-	public function beforeRename(BeforeNodeRenamedEvent $event): void {
-		try {
-			$source = $event->getSource();
-			$this->renamedNodes[$source->getId()] = $source;
-		} catch (InvalidPathException|NotFoundException $e) {
-			Server::get(LoggerInterface::class)->error(
-				'Exception thrown in file rename: ' . $e->getMessage(), ['app' => 'admin_audit', 'exception' => $e]
-			);
-			return;
-		}
-	}
-
 	/**
 	 * Logs rename actions of files
 	 */
 	public function afterRename(NodeRenamedEvent $event): void {
 		try {
 			$target = $event->getTarget();
-			$originalSource = $this->renamedNodes[$target->getId()];
+			$source = $event->getSource();
 			$params = [
 				'newid' => $target->getId(),
-				'oldpath' => mb_substr($originalSource->getInternalPath(), 5),
+				'oldpath' => mb_substr($source->getInternalPath(), 5),
 				'newpath' => mb_substr($target->getInternalPath(), 5),
 			];
 		} catch (InvalidPathException|NotFoundException $e) {

apps/admin_audit/lib/AppInfo/Application.php

@@ -41,7 +41,6 @@
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Events\Node\BeforeNodeDeletedEvent;
 use OCP\Files\Events\Node\BeforeNodeReadEvent;
-use OCP\Files\Events\Node\BeforeNodeRenamedEvent;
 use OCP\Files\Events\Node\NodeCopiedEvent;
 use OCP\Files\Events\Node\NodeCreatedEvent;
 use OCP\Files\Events\Node\NodeRenamedEvent;
@@ -168,13 +167,6 @@ private function tagHooks(IAuditLogger $logger,
 	private function fileHooks(IAuditLogger $logger, IEventDispatcher $eventDispatcher): void {
 		$fileActions = new Files($logger);
 
-		$eventDispatcher->addListener(
-			BeforeNodeRenamedEvent::class,
-			function (BeforeNodeRenamedEvent $event) use ($fileActions): void {
-				$fileActions->beforeRename($event);
-			}
-		);
-
 		$eventDispatcher->addListener(
 			NodeRenamedEvent::class,
 			function (NodeRenamedEvent $event) use ($fileActions): void {

apps/files_sharing/tests/EncryptedSizePropagationTest.php

@@ -16,12 +16,17 @@ class EncryptedSizePropagationTest extends SizePropagationTest {
 	use EncryptionTrait;
 
 	protected function setupUser($name, $password = '') {
+		$this->config->setAppValue('encryption', 'useMasterKey', '0');
 		$this->createUser($name, $password);
 		$tmpFolder = \OC::$server->getTempManager()->getTemporaryFolder();
 		$this->registerMount($name, '\OC\Files\Storage\Local', '/' . $name, ['datadir' => $tmpFolder]);
-		$this->config->setAppValue('encryption', 'useMasterKey', '0');
 		$this->setupForUser($name, $password);
 		$this->loginWithEncryption($name);
 		return new View('/' . $name . '/files');
 	}
+
+	protected function loginHelper($user, $create = false, $password = false) {
+		$this->setupForUser($user, $password);
+		parent::loginHelper($user, $create, $password);
+	}
 }

apps/files_sharing/tests/TestCase.php

@@ -102,7 +102,7 @@ protected function setUp(): void {
 		\OC::$server->get(DisplayNameCache::class)->clear();
 
 		//login as user1
-		self::loginHelper(self::TEST_FILES_SHARING_API_USER1);
+		$this->loginHelper(self::TEST_FILES_SHARING_API_USER1);
 
 		$this->data = 'foobar';
 		$this->view = new View('/' . self::TEST_FILES_SHARING_API_USER1 . '/files');
@@ -167,7 +167,7 @@ public static function tearDownAfterClass(): void {
 	 * @param bool $create
 	 * @param bool $password
 	 */
-	protected static function loginHelper($user, $create = false, $password = false) {
+	protected function loginHelper($user, $create = false, $password = false) {
 		if ($password === false) {
 			$password = $user;
 		}

apps/files_trashbin/tests/TrashbinTest.php

@@ -19,7 +19,7 @@
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\Constants;
 use OCP\Files\FileInfo;
-use OCP\IConfig;
+use OCP\Server;
 use OCP\Share\IShare;
 
 /**
@@ -110,8 +110,11 @@ protected function setUp(): void {
 
 		\OC::$server->getAppManager()->enableApp('files_trashbin');
 		$config = \OC::$server->getConfig();
-		$mockConfig = $this->createMock(IConfig::class);
-		$mockConfig
+		$mockConfig = $this->getMockBuilder(AllConfig::class)
+			->onlyMethods(['getSystemValue'])
+			->setConstructorArgs([Server::get(\OC\SystemConfig::class)])
+			->getMock();
+		$mockConfig->expects($this->any())
 			->method('getSystemValue')
 			->willReturnCallback(static function ($key, $default) use ($config) {
 				if ($key === 'filesystem_check_changes') {
@@ -120,16 +123,6 @@ protected function setUp(): void {
 					return $config->getSystemValue($key, $default);
 				}
 			});
-		$mockConfig
-			->method('getUserValue')
-			->willReturnCallback(static function ($userId, $appName, $key, $default = '') use ($config) {
-				return $config->getUserValue($userId, $appName, $key, $default);
-			});
-		$mockConfig
-			->method('getAppValue')
-			->willReturnCallback(static function ($appName, $key, $default = '') use ($config) {
-				return $config->getAppValue($appName, $key, $default);
-			});
 		$this->overwriteService(AllConfig::class, $mockConfig);
 
 		$this->trashRoot1 = '/' . self::TEST_TRASHBIN_USER1 . '/files_trashbin';

apps/files_versions/lib/Listener/FileEventsListener.php

@@ -241,7 +241,7 @@ public function post_write_hook(Node $node): void {
 	/**
 	 * Erase versions of deleted file
 	 *
-	 * This function is connected to the delete signal of OC_Filesystem
+	 * This function is connected to the NodeDeletedEvent event
 	 * cleanup the versions directory if the actual file gets deleted
 	 */
 	public function remove_hook(Node $node): void {
@@ -273,7 +273,7 @@ public function pre_remove_hook(Node $node): void {
 	/**
 	 * rename/move versions of renamed/moved files
 	 *
-	 * This function is connected to the rename signal of OC_Filesystem and adjust the name and location
+	 * This function is connected to the NodeRenamedEvent event and adjust the name and location
 	 * of the stored versions along the actual file
 	 */
 	public function rename_hook(Node $source, Node $target): void {
@@ -292,7 +292,7 @@ public function rename_hook(Node $source, Node $target): void {
 	/**
 	 * copy versions of copied files
 	 *
-	 * This function is connected to the copy signal of OC_Filesystem and copies the
+	 * This function is connected to the NodeCopiedEvent event and copies the
 	 * the stored versions to the new location
 	 */
 	public function copy_hook(Node $source, Node $target): void {

apps/files_versions/tests/VersioningTest.php

@@ -19,7 +19,6 @@
 use OCA\Files_Versions\Versions\IVersionManager;
 use OCP\Constants;
 use OCP\Files\IMimeTypeLoader;
-use OCP\IConfig;
 use OCP\IUser;
 use OCP\Server;
 use OCP\Share\IShare;
@@ -79,7 +78,10 @@ protected function setUp(): void {
 		parent::setUp();
 
 		$config = \OC::$server->getConfig();
-		$mockConfig = $this->createMock(IConfig::class);
+		$mockConfig = $this->getMockBuilder(AllConfig::class)
+			->onlyMethods(['getSystemValue'])
+			->setConstructorArgs([Server::get(\OC\SystemConfig::class)])
+			->getMock();
 		$mockConfig->expects($this->any())
 			->method('getSystemValue')
 			->willReturnCallback(function ($key, $default) use ($config) {
@@ -423,8 +425,24 @@ public function testMoveFileIntoSharedFolderAsRecipient(): void {
 		$this->rootView->file_put_contents($v2, 'version2');
 
 		// move file into the shared folder as recipient
-		Filesystem::rename('/test.txt', '/folder1/test.txt');
+		$success = Filesystem::rename('/test.txt', '/folder1/test.txt');
+
+		// TODO: Voir is $v2 existe pour voir si c’est la copie ou la suppression qui foire
+		// Mettre du debug dans Wrapper/Encrytion::copyBetweenStorage c’est le suspect n-1
+		$versionsFolder1 = '/' . self::TEST_VERSIONS_USER . '/files_versions';
 
+		$v1Renamed = $versionsFolder1 . '/folder1/test.txt.v' . $t1;
+		$v2Renamed = $versionsFolder1 . '/folder1/test.txt.v' . $t2;
+		var_dump([
+			'success' => $success,
+			'source exists' => Filesystem::file_exists('/test.txt'),
+			'target exists' => Filesystem::file_exists('/folder1/test.txt'),
+			'v1 exists' => $this->rootView->file_exists($v1),
+			'v2 exists' => $this->rootView->file_exists($v2),
+			'v1Renamed exists' => $this->rootView->file_exists($v1Renamed),
+			'v2Renamed exists' => $this->rootView->file_exists($v2Renamed),
+		]);
+		$this->assertTrue($success); // renvoi true :-O
 		$this->assertFalse($this->rootView->file_exists($v1));
 		$this->assertFalse($this->rootView->file_exists($v2));
 

build/psalm-baseline.xml

@@ -2031,9 +2031,6 @@
     </UndefinedInterfaceMethod>
   </file>
   <file src="lib/private/Files/Storage/Wrapper/Encryption.php">
-    <InvalidOperand>
-      <code><![CDATA[$this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename)]]></code>
-    </InvalidOperand>
     <InvalidReturnStatement>
       <code><![CDATA[$result]]></code>
     </InvalidReturnStatement>

lib/base.php

@@ -6,17 +6,16 @@
  * SPDX-FileCopyrightText: 2013-2016 ownCloud, Inc.
  * SPDX-License-Identifier: AGPL-3.0-only
  */
-use OC\Encryption\HookManager;
 use OC\Share20\Hooks;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Files\Events\BeforeFileSystemSetupEvent;
 use OCP\Group\Events\UserRemovedEvent;
 use OCP\ILogger;
 use OCP\IRequest;
 use OCP\IURLGenerator;
 use OCP\IUserSession;
 use OCP\Security\Bruteforce\IThrottler;
 use OCP\Server;
-use OCP\Share;
 use OCP\User\Events\UserChangedEvent;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Routing\Exception\MethodNotAllowedException;
@@ -868,15 +867,16 @@ public static function registerCleanupHooks(\OC\SystemConfig $systemConfig): voi
 	}
 
 	private static function registerEncryptionWrapperAndHooks(): void {
+		/** @var \OC\Encryption\Manager */
 		$manager = Server::get(\OCP\Encryption\IManager::class);
-		\OCP\Util::connectHook('OC_Filesystem', 'preSetup', $manager, 'setupStorage');
+		Server::get(IEventDispatcher::class)->addListener(
+			BeforeFileSystemSetupEvent::class,
+			$manager->setupStorage(...),
+		);
 
 		$enabled = $manager->isEnabled();
 		if ($enabled) {
-			\OCP\Util::connectHook(Share::class, 'post_shared', HookManager::class, 'postShared');
-			\OCP\Util::connectHook(Share::class, 'post_unshare', HookManager::class, 'postUnshared');
-			\OCP\Util::connectHook('OC_Filesystem', 'post_rename', HookManager::class, 'postRename');
-			\OCP\Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', HookManager::class, 'postRestore');
+			\OC\Encryption\EncryptionEventListener::register(Server::get(IEventDispatcher::class));
 		}
 	}
 

lib/composer/composer/autoload_classmap.php

@@ -1515,6 +1515,7 @@
     'OC\\DirectEditing\\Token' => $baseDir . '/lib/private/DirectEditing/Token.php',
     'OC\\EmojiHelper' => $baseDir . '/lib/private/EmojiHelper.php',
     'OC\\Encryption\\DecryptAll' => $baseDir . '/lib/private/Encryption/DecryptAll.php',
+    'OC\\Encryption\\EncryptionEventListener' => $baseDir . '/lib/private/Encryption/EncryptionEventListener.php',
     'OC\\Encryption\\EncryptionWrapper' => $baseDir . '/lib/private/Encryption/EncryptionWrapper.php',
     'OC\\Encryption\\Exceptions\\DecryptionFailedException' => $baseDir . '/lib/private/Encryption/Exceptions/DecryptionFailedException.php',
     'OC\\Encryption\\Exceptions\\EmptyEncryptionDataException' => $baseDir . '/lib/private/Encryption/Exceptions/EmptyEncryptionDataException.php',
@@ -1525,7 +1526,6 @@
     'OC\\Encryption\\Exceptions\\ModuleDoesNotExistsException' => $baseDir . '/lib/private/Encryption/Exceptions/ModuleDoesNotExistsException.php',
     'OC\\Encryption\\Exceptions\\UnknownCipherException' => $baseDir . '/lib/private/Encryption/Exceptions/UnknownCipherException.php',
     'OC\\Encryption\\File' => $baseDir . '/lib/private/Encryption/File.php',
-    'OC\\Encryption\\HookManager' => $baseDir . '/lib/private/Encryption/HookManager.php',
     'OC\\Encryption\\Keys\\Storage' => $baseDir . '/lib/private/Encryption/Keys/Storage.php',
     'OC\\Encryption\\Manager' => $baseDir . '/lib/private/Encryption/Manager.php',
     'OC\\Encryption\\Update' => $baseDir . '/lib/private/Encryption/Update.php',

lib/composer/composer/autoload_static.php

@@ -1564,6 +1564,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\DirectEditing\\Token' => __DIR__ . '/../../..' . '/lib/private/DirectEditing/Token.php',
         'OC\\EmojiHelper' => __DIR__ . '/../../..' . '/lib/private/EmojiHelper.php',
         'OC\\Encryption\\DecryptAll' => __DIR__ . '/../../..' . '/lib/private/Encryption/DecryptAll.php',
+        'OC\\Encryption\\EncryptionEventListener' => __DIR__ . '/../../..' . '/lib/private/Encryption/EncryptionEventListener.php',
         'OC\\Encryption\\EncryptionWrapper' => __DIR__ . '/../../..' . '/lib/private/Encryption/EncryptionWrapper.php',
         'OC\\Encryption\\Exceptions\\DecryptionFailedException' => __DIR__ . '/../../..' . '/lib/private/Encryption/Exceptions/DecryptionFailedException.php',
         'OC\\Encryption\\Exceptions\\EmptyEncryptionDataException' => __DIR__ . '/../../..' . '/lib/private/Encryption/Exceptions/EmptyEncryptionDataException.php',
@@ -1574,7 +1575,6 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Encryption\\Exceptions\\ModuleDoesNotExistsException' => __DIR__ . '/../../..' . '/lib/private/Encryption/Exceptions/ModuleDoesNotExistsException.php',
         'OC\\Encryption\\Exceptions\\UnknownCipherException' => __DIR__ . '/../../..' . '/lib/private/Encryption/Exceptions/UnknownCipherException.php',
         'OC\\Encryption\\File' => __DIR__ . '/../../..' . '/lib/private/Encryption/File.php',
-        'OC\\Encryption\\HookManager' => __DIR__ . '/../../..' . '/lib/private/Encryption/HookManager.php',
         'OC\\Encryption\\Keys\\Storage' => __DIR__ . '/../../..' . '/lib/private/Encryption/Keys/Storage.php',
         'OC\\Encryption\\Manager' => __DIR__ . '/../../..' . '/lib/private/Encryption/Manager.php',
         'OC\\Encryption\\Update' => __DIR__ . '/../../..' . '/lib/private/Encryption/Update.php',