1.2.0

eldertek · Jul 9, 2024 · 6469681 · 6469681
1 parent 01d5408
commit 6469681
Show file tree

Hide file tree

Showing 10 changed files with 139 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.2.0 - 2024-07-09
+### Fixed
+- File locking when interupting the scan
+
 ## 1.1.11 - 2024-07-05
 ### Added
 - Multi-select feature for duplicates

diff --git a/js/duplicatefinder-main.js b/js/duplicatefinder-main.js
diff --git a/js/duplicatefinder-settings.js b/js/duplicatefinder-settings.js
diff --git a/lib/Command/FindDuplicates.php b/lib/Command/FindDuplicates.php
@@ -11,6 +11,8 @@
 use OCP\IDBConnection;
 use OCP\IUser;
 use OCP\IUserManager;
+use OCP\Lock\ILockingProvider;
+use OCP\Lock\LockedException;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -111,6 +113,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $users = (array)$input->getOption('user');
         $paths = (array)$input->getOption('path');
 
+        // Set up signal handler for SIGINT (Ctrl+C)
+        pcntl_signal(SIGINT, function () {
+            $this->output->writeln("\n<comment>Scan aborted by user.</comment>");
+            exit(1);
+        });
+
         return (!empty($users)) ? $this->findDuplicatesForUsers($users, $paths) : $this->findAllDuplicates($paths);
     }
 
@@ -164,7 +172,8 @@ private function findAllDuplicates(array $paths): int
     private function findDuplicates(string $user, array $paths): void
     {
         $callback = function () {
-            // Handle interruption if needed
+            pcntl_signal_dispatch();
+            return false; // Continue scanning
         };
 
         if (empty($paths)) {
@@ -177,4 +186,4 @@ private function findDuplicates(string $user, array $paths): void
 
         CMDUtils::showDuplicates($this->fileDuplicateService, $this->output, $callback, $user);
     }
-}
+}
diff --git a/lib/Command/ListDuplicates.php b/lib/Command/ListDuplicates.php
@@ -128,8 +128,11 @@ private function listDuplicatesForUsers(array $users): int
       */
      private function listAllDuplicates(): int
      {
-         CMDUtils::showDuplicates($this->fileDuplicateService, $this->output, function() {});
+         // Assuming you want to list duplicates for all users, you might need to iterate over all users
+         $users = $this->userManager->search('');
+         foreach ($users as $user) {
+             CMDUtils::showDuplicates($this->fileDuplicateService, $this->output, function() {}, $user->getUID());
+         }
          return 0;
      }
- }
-
+ }
diff --git a/lib/Service/FileDuplicateService.php b/lib/Service/FileDuplicateService.php
@@ -82,7 +82,9 @@ public function findAll(
             $entities = $this->mapper->findAll($user, $pageSize, $offset, $orderBy);
 
             foreach ($entities as $entity) {
-                $entity = $this->stripFilesWithoutAccessRights($entity, $user);
+                if ($user !== null) {
+                    $entity = $this->stripFilesWithoutAccessRights($entity, $user);
+                }
                 if ($enrich) {
                     $entity = $this->enrich($entity);
                 }
@@ -112,22 +114,18 @@ public function findAll(
 
     private function stripFilesWithoutAccessRights(
         FileDuplicate $duplicate,
-        ?string $user
+        string $user
     ): FileDuplicate {
         $files = $this->fileInfoService->findByHash($duplicate->getHash(), $duplicate->getType());
-        $duplicate->setFiles($files);
-        if (is_null($user)) {
-            return $duplicate;
-        }
-        foreach ($duplicate->getFiles() as $fileId => $fileInfo) {
-            if (is_string($fileInfo)) {
-                continue;
-            }
-            if (!$this->fileInfoService->hasAccessRight($fileInfo, $user)) {
-                $duplicate->removeDuplicate($fileId);
+        $accessibleFiles = [];
+
+        foreach ($files as $fileInfo) {
+            if ($this->fileInfoService->hasAccessRight($fileInfo, $user)) {
+                $accessibleFiles[] = $fileInfo;
             }
         }
-        unset($fileInfo);
+
+        $duplicate->setFiles($accessibleFiles);
         return $duplicate;
     }
 
@@ -180,4 +178,4 @@ public function getTotalCount(string $type = 'unacknowledged'): int
     {
         return $this->mapper->getTotalCount($type);
     }
-}
+}
diff --git a/lib/Service/FileInfoService.php b/lib/Service/FileInfoService.php
@@ -7,6 +7,10 @@
 use OCP\Files\Node;
 use OCP\Files\NotFoundException;
 use Symfony\Component\Console\Output\OutputInterface;
+use OCP\Lock\ILockingProvider;
+use OCP\Files\Storage\IStorage;
+use OCP\Files\IRootFolder;
+use OCP\IDBConnection;
 
 use OCA\DuplicateFinder\AppInfo\Application;
 use OCA\DuplicateFinder\Db\FileInfo;
@@ -35,6 +39,9 @@ class FileInfoService
     private $scannerUtil;
     /** @var FilterService */
     private $filterService;
+    private $lockingProvider;
+    private $rootFolder;
+    private $connection;
 
     public function __construct(
         FileInfoMapper $mapper,
@@ -43,7 +50,10 @@ public function __construct(
         ShareService $shareService,
         FilterService $filterService,
         FolderService $folderService,
-        ScannerUtil $scannerUtil
+        ScannerUtil $scannerUtil,
+        ILockingProvider $lockingProvider,
+        IRootFolder $rootFolder,
+        IDBConnection $connection
     ) {
         $this->mapper = $mapper;
         $this->eventDispatcher = $eventDispatcher;
@@ -52,6 +62,9 @@ public function __construct(
         $this->filterService = $filterService;
         $this->folderService = $folderService;
         $this->scannerUtil = $scannerUtil;
+        $this->lockingProvider = $lockingProvider;
+        $this->rootFolder = $rootFolder;
+        $this->connection = $connection;
     }
 
     /**
@@ -269,6 +282,8 @@ public function scanFiles(
         try {
             $this->scannerUtil->setHandles($this, $output, $abortIfInterrupted);
             $this->scannerUtil->scan($user, $scanPath);
+        } catch (\OCP\Lock\LockedException $e) {
+            $this->handleLockedFile($e->getPath(), $output);
         } catch (NotFoundException $e) {
             $this->logger->error('The given scan path doesn\'t exists.', ['app' => Application::ID, 'exception' => $e]);
             CMDUtils::showIfOutputIsPresent(
@@ -284,26 +299,86 @@ public function scanFiles(
         }
     }
 
-    public function hasAccessRight(FileInfo $fileInfo, string $user): ?FileInfo
+    private function handleLockedFile(string $path, ?OutputInterface $output): void
     {
-        $result = null;
-        if ($fileInfo->getOwner() === $user) {
-            $result = $fileInfo;
-        } else {
-            try {
-                $path = $this->shareService->hasAccessRight(
-                    $this->folderService->getNodeByFileInfo($fileInfo, $user),
-                    $user
+        try {
+            // Get the file node
+            $node = $this->rootFolder->get($path);
+            $storage = $node->getStorage();
+
+            if ($storage instanceof IStorage) {
+                // Try to release the lock at the storage level
+                $storage->unlockFile($path, ILockingProvider::LOCK_SHARED);
+                CMDUtils::showIfOutputIsPresent(
+                    "Released storage-level lock for file: $path",
+                    $output
                 );
-                if (!is_null($path)) {
-                    $fileInfo->setPath($path);
-                    $result = $fileInfo;
-                }
-            } catch (NotFoundException $e) {
-                $result = null;
             }
+
+            // Try to release the lock at the application level
+            $this->lockingProvider->releaseAll($path, ILockingProvider::LOCK_SHARED);
+            CMDUtils::showIfOutputIsPresent(
+                "Released application-level lock for file: $path",
+                $output
+            );
+
+            // Check if the file is still locked
+            if ($this->lockingProvider->isLocked($path, ILockingProvider::LOCK_SHARED)) {
+                CMDUtils::showIfOutputIsPresent(
+                    "<error>File is still locked after release attempt: $path</error>",
+                    $output
+                );
+                // Call the method to disable all locks
+                $this->disableAllLocks($output);
+            } else {
+                CMDUtils::showIfOutputIsPresent(
+                    "<info>Successfully released all locks for file: $path</info>",
+                    $output
+                );
+            }
+        } catch (\Exception $e) {
+            CMDUtils::showIfOutputIsPresent(
+                "<error>Failed to release lock for file: $path - " . $e->getMessage() . "</error>",
+                $output
+            );
+            $this->logger->error("Failed to release lock for file: $path", ['exception' => $e]);
+            // Call the method to disable all locks
+            $this->disableAllLocks($output);
+        }
+    }
+
+    private function disableAllLocks(?OutputInterface $output): void
+    {
+        try {
+            $query = $this->connection->prepare('DELETE FROM oc_file_locks WHERE true');
+            $query->execute();
+            CMDUtils::showIfOutputIsPresent(
+                "<info>All locks have been disabled by emptying the oc_file_locks table.</info>",
+                $output
+            );
+        } catch (\Exception $e) {
+            CMDUtils::showIfOutputIsPresent(
+                "<error>Failed to disable all locks: " . $e->getMessage() . "</error>",
+                $output
+            );
+            $this->logger->error("Failed to disable all locks", ['exception' => $e]);
+        }
+    }
+
+    public function hasAccessRight(FileInfo $fileInfo, string $user): bool
+    {
+        if ($fileInfo->getOwner() === $user) {
+            return true;
         }
 
-        return $result;
+        try {
+            $path = $this->shareService->hasAccessRight(
+                $this->folderService->getNodeByFileInfo($fileInfo, $user),
+                $user
+            );
+            return !is_null($path);
+        } catch (NotFoundException $e) {
+            return false;
+        }
     }
-}
+}
diff --git a/lib/Utils/ScannerUtil.php b/lib/Utils/ScannerUtil.php
@@ -7,6 +7,7 @@
 use OCP\IDBConnection;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\NotFoundException;
+use OCP\Lock\LockedException;
 
 use OCA\DuplicateFinder\AppInfo\Application;
 use OCA\DuplicateFinder\Exception\ForcedToIgnoreFileException;
@@ -67,6 +68,9 @@ public function scan(string $user, string $path, bool $isShared = false) : void
                 $this->scanSharedFiles($user, $path);
                 $this->showOutput('Finished searching files');
             }
+        } catch (LockedException $e) {
+            $this->showOutput('<error>File locked, attempting to release: ' . $e->getPath() . '</error>');
+            throw $e; // Rethrow to be handled in FileInfoService
         } catch (\Exception $e) {
             $errorMessage = 'An error occurred during scanning: ' . $e->getMessage();
             $this->logger->error($errorMessage, ['app' => Application::ID, 'exception' => $e]);
@@ -106,7 +110,9 @@ private function saveScannedFile(
         }
         if ($this->abortIfInterrupted) {
             $abort = $this->abortIfInterrupted;
-            $abort();
+            if ($abort()) {
+                throw new \Exception('Scan aborted by user');
+            }
         }
     }
 
@@ -138,4 +144,4 @@ private function showOutput(string $message, bool $isVerbose = false) : void
         );
     }
 
-}
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "duplicatefinder",
   "description": "Save some space by finding your duplicate files",
-  "version": "1.1.11",
+  "version": "1.2.0",
   "author": "André Théo LAURET <andrelauret@eclipse-technology.eu>",
   "contributors": [],
   "bugs": {