nextcloud / server

apps/files_external/lib/Command/Notify.php

Indentation +231 added lines, -231 removed lines

@@ -47,262 +47,262 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Notify extends Base {
-	/** @var GlobalStoragesService */
-	private $globalService;
-	/** @var IDBConnection */
-	private $connection;
-	/** @var ILogger */
-	private $logger;
+    /** @var GlobalStoragesService */
+    private $globalService;
+    /** @var IDBConnection */
+    private $connection;
+    /** @var ILogger */
+    private $logger;
 
-	public function __construct(GlobalStoragesService $globalService, IDBConnection $connection, ILogger $logger) {
-		parent::__construct();
-		$this->globalService = $globalService;
-		$this->connection = $connection;
-		$this->logger = $logger;
-	}
+    public function __construct(GlobalStoragesService $globalService, IDBConnection $connection, ILogger $logger) {
+        parent::__construct();
+        $this->globalService = $globalService;
+        $this->connection = $connection;
+        $this->logger = $logger;
+    }
 
-	protected function configure() {
-		$this
-			->setName('files_external:notify')
-			->setDescription('Listen for active update notifications for a configured external mount')
-			->addArgument(
-				'mount_id',
-				InputArgument::REQUIRED,
-				'the mount id of the mount to listen to'
-			)->addOption(
-				'user',
-				'u',
-				InputOption::VALUE_REQUIRED,
-				'The username for the remote mount (required only for some mount configuration that don\'t store credentials)'
-			)->addOption(
-				'password',
-				'p',
-				InputOption::VALUE_REQUIRED,
-				'The password for the remote mount (required only for some mount configuration that don\'t store credentials)'
-			)->addOption(
-				'path',
-				'',
-				InputOption::VALUE_REQUIRED,
-				'The directory in the storage to listen for updates in',
-				'/'
-			)->addOption(
-				'no-self-check',
-				'',
-				InputOption::VALUE_NONE,
-				'Disable self check on startup'
-			);
-		parent::configure();
-	}
+    protected function configure() {
+        $this
+            ->setName('files_external:notify')
+            ->setDescription('Listen for active update notifications for a configured external mount')
+            ->addArgument(
+                'mount_id',
+                InputArgument::REQUIRED,
+                'the mount id of the mount to listen to'
+            )->addOption(
+                'user',
+                'u',
+                InputOption::VALUE_REQUIRED,
+                'The username for the remote mount (required only for some mount configuration that don\'t store credentials)'
+            )->addOption(
+                'password',
+                'p',
+                InputOption::VALUE_REQUIRED,
+                'The password for the remote mount (required only for some mount configuration that don\'t store credentials)'
+            )->addOption(
+                'path',
+                '',
+                InputOption::VALUE_REQUIRED,
+                'The directory in the storage to listen for updates in',
+                '/'
+            )->addOption(
+                'no-self-check',
+                '',
+                InputOption::VALUE_NONE,
+                'Disable self check on startup'
+            );
+        parent::configure();
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$mount = $this->globalService->getStorage($input->getArgument('mount_id'));
-		if (is_null($mount)) {
-			$output->writeln('<error>Mount not found</error>');
-			return 1;
-		}
-		$noAuth = false;
-		try {
-			$authBackend = $mount->getAuthMechanism();
-			$authBackend->manipulateStorageConfig($mount);
-		} catch (InsufficientDataForMeaningfulAnswerException $e) {
-			$noAuth = true;
-		} catch (StorageNotAvailableException $e) {
-			$noAuth = true;
-		}
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $mount = $this->globalService->getStorage($input->getArgument('mount_id'));
+        if (is_null($mount)) {
+            $output->writeln('<error>Mount not found</error>');
+            return 1;
+        }
+        $noAuth = false;
+        try {
+            $authBackend = $mount->getAuthMechanism();
+            $authBackend->manipulateStorageConfig($mount);
+        } catch (InsufficientDataForMeaningfulAnswerException $e) {
+            $noAuth = true;
+        } catch (StorageNotAvailableException $e) {
+            $noAuth = true;
+        }
 
-		if ($input->getOption('user')) {
-			$mount->setBackendOption('user', $input->getOption('user'));
-		} elseif (isset($_ENV['NOTIFY_USER'])) {
-			$mount->setBackendOption('user', $_ENV['NOTIFY_USER']);
-		} elseif (isset($_SERVER['NOTIFY_USER'])) {
-			$mount->setBackendOption('user', $_SERVER['NOTIFY_USER']);
-		}
-		if ($input->getOption('password')) {
-			$mount->setBackendOption('password', $input->getOption('password'));
-		} elseif (isset($_ENV['NOTIFY_PASSWORD'])) {
-			$mount->setBackendOption('password', $_ENV['NOTIFY_PASSWORD']);
-		} elseif (isset($_SERVER['NOTIFY_PASSWORD'])) {
-			$mount->setBackendOption('password', $_SERVER['NOTIFY_PASSWORD']);
-		}
+        if ($input->getOption('user')) {
+            $mount->setBackendOption('user', $input->getOption('user'));
+        } elseif (isset($_ENV['NOTIFY_USER'])) {
+            $mount->setBackendOption('user', $_ENV['NOTIFY_USER']);
+        } elseif (isset($_SERVER['NOTIFY_USER'])) {
+            $mount->setBackendOption('user', $_SERVER['NOTIFY_USER']);
+        }
+        if ($input->getOption('password')) {
+            $mount->setBackendOption('password', $input->getOption('password'));
+        } elseif (isset($_ENV['NOTIFY_PASSWORD'])) {
+            $mount->setBackendOption('password', $_ENV['NOTIFY_PASSWORD']);
+        } elseif (isset($_SERVER['NOTIFY_PASSWORD'])) {
+            $mount->setBackendOption('password', $_SERVER['NOTIFY_PASSWORD']);
+        }
 
-		try {
-			$storage = $this->createStorage($mount);
-		} catch (\Exception $e) {
-			$output->writeln('<error>Error while trying to create storage</error>');
-			if ($noAuth) {
-				$output->writeln('<error>Username and/or password required</error>');
-			}
-			return 1;
-		}
-		if (!$storage instanceof INotifyStorage) {
-			$output->writeln('<error>Mount of type "' . $mount->getBackend()->getText() . '" does not support active update notifications</error>');
-			return 1;
-		}
+        try {
+            $storage = $this->createStorage($mount);
+        } catch (\Exception $e) {
+            $output->writeln('<error>Error while trying to create storage</error>');
+            if ($noAuth) {
+                $output->writeln('<error>Username and/or password required</error>');
+            }
+            return 1;
+        }
+        if (!$storage instanceof INotifyStorage) {
+            $output->writeln('<error>Mount of type "' . $mount->getBackend()->getText() . '" does not support active update notifications</error>');
+            return 1;
+        }
 
-		$verbose = $input->getOption('verbose');
+        $verbose = $input->getOption('verbose');
 
-		$path = trim($input->getOption('path'), '/');
-		$notifyHandler = $storage->notify($path);
+        $path = trim($input->getOption('path'), '/');
+        $notifyHandler = $storage->notify($path);
 
-		if (!$input->getOption('no-self-check')) {
-			$this->selfTest($storage, $notifyHandler, $verbose, $output);
-		}
+        if (!$input->getOption('no-self-check')) {
+            $this->selfTest($storage, $notifyHandler, $verbose, $output);
+        }
 
-		$notifyHandler->listen(function (IChange $change) use ($mount, $verbose, $output) {
-			if ($verbose) {
-				$this->logUpdate($change, $output);
-			}
-			if ($change instanceof IRenameChange) {
-				$this->markParentAsOutdated($mount->getId(), $change->getTargetPath(), $output);
-			}
-			$this->markParentAsOutdated($mount->getId(), $change->getPath(), $output);
-		});
-		return 0;
-	}
+        $notifyHandler->listen(function (IChange $change) use ($mount, $verbose, $output) {
+            if ($verbose) {
+                $this->logUpdate($change, $output);
+            }
+            if ($change instanceof IRenameChange) {
+                $this->markParentAsOutdated($mount->getId(), $change->getTargetPath(), $output);
+            }
+            $this->markParentAsOutdated($mount->getId(), $change->getPath(), $output);
+        });
+        return 0;
+    }
 
-	private function createStorage(StorageConfig $mount) {
-		$class = $mount->getBackend()->getStorageClass();
-		return new $class($mount->getBackendOptions());
-	}
+    private function createStorage(StorageConfig $mount) {
+        $class = $mount->getBackend()->getStorageClass();
+        return new $class($mount->getBackendOptions());
+    }
 
-	private function markParentAsOutdated($mountId, $path, OutputInterface $output) {
-		$parent = ltrim(dirname($path), '/');
-		if ($parent === '.') {
-			$parent = '';
-		}
+    private function markParentAsOutdated($mountId, $path, OutputInterface $output) {
+        $parent = ltrim(dirname($path), '/');
+        if ($parent === '.') {
+            $parent = '';
+        }
 
-		try {
-			$storageIds = $this->getStorageIds($mountId);
-		} catch (DriverException $ex) {
-			$this->logger->logException($ex, ['message' => 'Error while trying to find correct storage ids.', 'level' => ILogger::WARN]);
-			$this->connection = $this->reconnectToDatabase($this->connection, $output);
-			$output->writeln('<info>Needed to reconnect to the database</info>');
-			$storageIds = $this->getStorageIds($mountId);
-		}
-		if (count($storageIds) === 0) {
-			throw new StorageNotAvailableException('No storages found by mount ID ' . $mountId);
-		}
-		$storageIds = array_map('intval', $storageIds);
+        try {
+            $storageIds = $this->getStorageIds($mountId);
+        } catch (DriverException $ex) {
+            $this->logger->logException($ex, ['message' => 'Error while trying to find correct storage ids.', 'level' => ILogger::WARN]);
+            $this->connection = $this->reconnectToDatabase($this->connection, $output);
+            $output->writeln('<info>Needed to reconnect to the database</info>');
+            $storageIds = $this->getStorageIds($mountId);
+        }
+        if (count($storageIds) === 0) {
+            throw new StorageNotAvailableException('No storages found by mount ID ' . $mountId);
+        }
+        $storageIds = array_map('intval', $storageIds);
 
-		$result = $this->updateParent($storageIds, $parent);
-		if ($result === 0) {
-			//TODO: Find existing parent further up the tree in the database and register that folder instead.
-			$this->logger->info('Failed updating parent for "' . $path . '" while trying to register change. It may not exist in the filecache.');
-		}
-	}
+        $result = $this->updateParent($storageIds, $parent);
+        if ($result === 0) {
+            //TODO: Find existing parent further up the tree in the database and register that folder instead.
+            $this->logger->info('Failed updating parent for "' . $path . '" while trying to register change. It may not exist in the filecache.');
+        }
+    }
 
-	private function logUpdate(IChange $change, OutputInterface $output) {
-		switch ($change->getType()) {
-			case INotifyStorage::NOTIFY_ADDED:
-				$text = 'added';
-				break;
-			case INotifyStorage::NOTIFY_MODIFIED:
-				$text = 'modified';
-				break;
-			case INotifyStorage::NOTIFY_REMOVED:
-				$text = 'removed';
-				break;
-			case INotifyStorage::NOTIFY_RENAMED:
-				$text = 'renamed';
-				break;
-			default:
-				return;
-		}
+    private function logUpdate(IChange $change, OutputInterface $output) {
+        switch ($change->getType()) {
+            case INotifyStorage::NOTIFY_ADDED:
+                $text = 'added';
+                break;
+            case INotifyStorage::NOTIFY_MODIFIED:
+                $text = 'modified';
+                break;
+            case INotifyStorage::NOTIFY_REMOVED:
+                $text = 'removed';
+                break;
+            case INotifyStorage::NOTIFY_RENAMED:
+                $text = 'renamed';
+                break;
+            default:
+                return;
+        }
 
-		$text .= ' ' . $change->getPath();
-		if ($change instanceof IRenameChange) {
-			$text .= ' to ' . $change->getTargetPath();
-		}
+        $text .= ' ' . $change->getPath();
+        if ($change instanceof IRenameChange) {
+            $text .= ' to ' . $change->getTargetPath();
+        }
 
-		$output->writeln($text);
-	}
+        $output->writeln($text);
+    }
 
-	/**
-	 * @param int $mountId
-	 * @return array
-	 */
-	private function getStorageIds($mountId) {
-		$qb = $this->connection->getQueryBuilder();
-		return $qb
-			->select('storage_id')
-			->from('mounts')
-			->where($qb->expr()->eq('mount_id', $qb->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
-			->execute()
-			->fetchAll(\PDO::FETCH_COLUMN);
-	}
+    /**
+     * @param int $mountId
+     * @return array
+     */
+    private function getStorageIds($mountId) {
+        $qb = $this->connection->getQueryBuilder();
+        return $qb
+            ->select('storage_id')
+            ->from('mounts')
+            ->where($qb->expr()->eq('mount_id', $qb->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
+            ->execute()
+            ->fetchAll(\PDO::FETCH_COLUMN);
+    }
 
-	/**
-	 * @param array $storageIds
-	 * @param string $parent
-	 * @return int
-	 */
-	private function updateParent($storageIds, $parent) {
-		$pathHash = md5(trim(\OC_Util::normalizeUnicode($parent), '/'));
-		$qb = $this->connection->getQueryBuilder();
-		return $qb
-			->update('filecache')
-			->set('size', $qb->createNamedParameter(-1, IQueryBuilder::PARAM_INT))
-			->where($qb->expr()->in('storage', $qb->createNamedParameter($storageIds, IQueryBuilder::PARAM_INT_ARRAY, ':storage_ids')))
-			->andWhere($qb->expr()->eq('path_hash', $qb->createNamedParameter($pathHash, IQueryBuilder::PARAM_STR)))
-			->execute();
-	}
+    /**
+     * @param array $storageIds
+     * @param string $parent
+     * @return int
+     */
+    private function updateParent($storageIds, $parent) {
+        $pathHash = md5(trim(\OC_Util::normalizeUnicode($parent), '/'));
+        $qb = $this->connection->getQueryBuilder();
+        return $qb
+            ->update('filecache')
+            ->set('size', $qb->createNamedParameter(-1, IQueryBuilder::PARAM_INT))
+            ->where($qb->expr()->in('storage', $qb->createNamedParameter($storageIds, IQueryBuilder::PARAM_INT_ARRAY, ':storage_ids')))
+            ->andWhere($qb->expr()->eq('path_hash', $qb->createNamedParameter($pathHash, IQueryBuilder::PARAM_STR)))
+            ->execute();
+    }
 
-	/**
-	 * @return \OCP\IDBConnection
-	 */
-	private function reconnectToDatabase(IDBConnection $connection, OutputInterface $output) {
-		try {
-			$connection->close();
-		} catch (\Exception $ex) {
-			$this->logger->logException($ex, ['app' => 'files_external', 'message' => 'Error while disconnecting from DB', 'level' => ILogger::WARN]);
-			$output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
-		}
-		while (!$connection->isConnected()) {
-			try {
-				$connection->connect();
-			} catch (\Exception $ex) {
-				$this->logger->logException($ex, ['app' => 'files_external', 'message' => 'Error while re-connecting to database', 'level' => ILogger::WARN]);
-				$output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
-				sleep(60);
-			}
-		}
-		return $connection;
-	}
+    /**
+     * @return \OCP\IDBConnection
+     */
+    private function reconnectToDatabase(IDBConnection $connection, OutputInterface $output) {
+        try {
+            $connection->close();
+        } catch (\Exception $ex) {
+            $this->logger->logException($ex, ['app' => 'files_external', 'message' => 'Error while disconnecting from DB', 'level' => ILogger::WARN]);
+            $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
+        }
+        while (!$connection->isConnected()) {
+            try {
+                $connection->connect();
+            } catch (\Exception $ex) {
+                $this->logger->logException($ex, ['app' => 'files_external', 'message' => 'Error while re-connecting to database', 'level' => ILogger::WARN]);
+                $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
+                sleep(60);
+            }
+        }
+        return $connection;
+    }
 
 
-	private function selfTest(IStorage $storage, INotifyHandler $notifyHandler, $verbose, OutputInterface $output) {
-		usleep(100 * 1000); //give time for the notify to start
-		$storage->file_put_contents('/.nc_test_file.txt', 'test content');
-		$storage->mkdir('/.nc_test_folder');
-		$storage->file_put_contents('/.nc_test_folder/subfile.txt', 'test content');
+    private function selfTest(IStorage $storage, INotifyHandler $notifyHandler, $verbose, OutputInterface $output) {
+        usleep(100 * 1000); //give time for the notify to start
+        $storage->file_put_contents('/.nc_test_file.txt', 'test content');
+        $storage->mkdir('/.nc_test_folder');
+        $storage->file_put_contents('/.nc_test_folder/subfile.txt', 'test content');
 
-		usleep(100 * 1000); //time for all changes to be processed
-		$changes = $notifyHandler->getChanges();
+        usleep(100 * 1000); //time for all changes to be processed
+        $changes = $notifyHandler->getChanges();
 
-		$storage->unlink('/.nc_test_file.txt');
-		$storage->unlink('/.nc_test_folder/subfile.txt');
-		$storage->rmdir('/.nc_test_folder');
+        $storage->unlink('/.nc_test_file.txt');
+        $storage->unlink('/.nc_test_folder/subfile.txt');
+        $storage->rmdir('/.nc_test_folder');
 
-		usleep(100 * 1000); //time for all changes to be processed
-		$notifyHandler->getChanges(); // flush
+        usleep(100 * 1000); //time for all changes to be processed
+        $notifyHandler->getChanges(); // flush
 
-		$foundRootChange = false;
-		$foundSubfolderChange = false;
+        $foundRootChange = false;
+        $foundSubfolderChange = false;
 
-		foreach ($changes as $change) {
-			if ($change->getPath() === '/.nc_test_file.txt' || $change->getPath() === '.nc_test_file.txt') {
-				$foundRootChange = true;
-			} elseif ($change->getPath() === '/.nc_test_folder/subfile.txt' || $change->getPath() === '.nc_test_folder/subfile.txt') {
-				$foundSubfolderChange = true;
-			}
-		}
+        foreach ($changes as $change) {
+            if ($change->getPath() === '/.nc_test_file.txt' || $change->getPath() === '.nc_test_file.txt') {
+                $foundRootChange = true;
+            } elseif ($change->getPath() === '/.nc_test_folder/subfile.txt' || $change->getPath() === '.nc_test_folder/subfile.txt') {
+                $foundSubfolderChange = true;
+            }
+        }
 
-		if ($foundRootChange && $foundSubfolderChange && $verbose) {
-			$output->writeln('<info>Self-test successful</info>');
-		} elseif ($foundRootChange && !$foundSubfolderChange) {
-			$output->writeln('<error>Error while running self-test, change is subfolder not detected</error>');
-		} elseif (!$foundRootChange) {
-			$output->writeln('<error>Error while running self-test, no changes detected</error>');
-		}
-	}
+        if ($foundRootChange && $foundSubfolderChange && $verbose) {
+            $output->writeln('<info>Self-test successful</info>');
+        } elseif ($foundRootChange && !$foundSubfolderChange) {
+            $output->writeln('<error>Error while running self-test, change is subfolder not detected</error>');
+        } elseif (!$foundRootChange) {
+            $output->writeln('<error>Error while running self-test, no changes detected</error>');
+        }
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -135,7 +135,7 @@ 
 			return 1;
 		}
 		if (!$storage instanceof INotifyStorage) {
-			$output->writeln('<error>Mount of type "' . $mount->getBackend()->getText() . '" does not support active update notifications</error>');
+			$output->writeln('<error>Mount of type "'.$mount->getBackend()->getText().'" does not support active update notifications</error>');
 			return 1;
 		}
 
@@ -148,7 +148,7 @@ 
 			$this->selfTest($storage, $notifyHandler, $verbose, $output);
 		}
 
-		$notifyHandler->listen(function (IChange $change) use ($mount, $verbose, $output) {
+		$notifyHandler->listen(function(IChange $change) use ($mount, $verbose, $output) {
 			if ($verbose) {
 				$this->logUpdate($change, $output);
 			}
@@ -180,14 +180,14 @@ 
 			$storageIds = $this->getStorageIds($mountId);
 		}
 		if (count($storageIds) === 0) {
-			throw new StorageNotAvailableException('No storages found by mount ID ' . $mountId);
+			throw new StorageNotAvailableException('No storages found by mount ID '.$mountId);
 		}
 		$storageIds = array_map('intval', $storageIds);
 
 		$result = $this->updateParent($storageIds, $parent);
 		if ($result === 0) {
 			//TODO: Find existing parent further up the tree in the database and register that folder instead.
-			$this->logger->info('Failed updating parent for "' . $path . '" while trying to register change. It may not exist in the filecache.');
+			$this->logger->info('Failed updating parent for "'.$path.'" while trying to register change. It may not exist in the filecache.');
 		}
 	}
 
@@ -209,9 +209,9 @@ 
 				return;
 		}
 
-		$text .= ' ' . $change->getPath();
+		$text .= ' '.$change->getPath();
 		if ($change instanceof IRenameChange) {
-			$text .= ' to ' . $change->getTargetPath();
+			$text .= ' to '.$change->getTargetPath();
 		}
 
 		$output->writeln($text);