Merge pull request #11664 from nextcloud/feature/noid/has-been-interrupted-throw-exception

Syntactic sugar for hasBeenInterrupted

apps/files/lib/Command/Scan.php

@@ -129,33 +129,25 @@ class Scan extends Base {
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
 				$output->writeln("\tFile   <info>$path</info>");
 				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
 				$output->writeln("\tFolder <info>$path</info>");
 				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+				$output->writeln('Error while scanning, storage not available (' . $e->getMessage() . ')');
 			});
 			# count only
 		} else {
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
 				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
 				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 		}
 		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
@@ -173,7 +165,7 @@ class Scan extends Base {
 			}
 		} catch (ForbiddenException $e) {
 			$output->writeln("<error>Home storage for user $user not writable</error>");
-			$output->writeln("Make sure you're running the scan command only as the user the web server runs as");
+			$output->writeln('Make sure you\'re running the scan command only as the user the web server runs as');
 		} catch (InterruptedException $e) {
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');
@@ -250,8 +242,10 @@ class Scan extends Base {
 			} else {
 				$output->writeln("<error>Unknown user $user_count $user</error>");
 			}
-			# check on each user if there was a user interrupt (ctrl-c) and exit foreach
-			if ($this->hasBeenInterrupted()) {
+
+			try {
+				$this->abortIfInterrupted();
+			} catch(InterruptedException $e) {
 				break;
 			}
 		}

apps/files/lib/Command/ScanAppData.php

@@ -102,33 +102,25 @@ class ScanAppData extends Base {
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
 				$output->writeln("\tFile   <info>$path</info>");
 				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
 				$output->writeln("\tFolder <info>$path</info>");
 				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+				$output->writeln('Error while scanning, storage not available (' . $e->getMessage() . ')');
 			});
 			# count only
 		} else {
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
 				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
 				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
+				$this->abortIfInterrupted();
 			});
 		}
 		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
@@ -142,7 +134,7 @@ class ScanAppData extends Base {
 			$scanner->scan($appData->getPath());
 		} catch (ForbiddenException $e) {
 			$output->writeln("<error>Storage not writable</error>");
-			$output->writeln("Make sure you're running the scan command only as the user the web server runs as");
+			$output->writeln('Make sure you\'re running the scan command only as the user the web server runs as');
 		} catch (InterruptedException $e) {
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');

core/Command/Base.php

@@ -129,15 +129,19 @@ class Base extends Command implements CompletionAwareInterface {
 	}
 
 	/**
-	 * @return bool
+	 * Throw InterruptedException when interrupted by user
+	 *
+	 * @throws InterruptedException
 	 */
-	protected function hasBeenInterrupted() {
-		// return always false if pcntl_signal functions are not accessible
-		if ($this->php_pcntl_signal) {
-			pcntl_signal_dispatch();
-			return $this->interrupted;
-		} else {
-			return false;
+	protected function abortIfInterrupted() {
+		if ($this->php_pcntl_signal === false) {
+			return;
+		}
+
+		pcntl_signal_dispatch();
+
+		if ($this->interrupted === true) {
+			throw new InterruptedException('Command interrupted by user');
 		}
 	}