nextcloud / server

apps/files/lib/Command/ScanAppData.php

Unused Use Statements -2 removed lines

@@ -12,8 +12,6 @@
 use OCP\Files\StorageNotAvailableException;
 use OCP\IConfig;
 use OCP\IDBConnection;
-use OCP\IUserManager;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;

Indentation +260 added lines, -260 removed lines

@@ -21,264 +21,264 @@
 
 class ScanAppData extends Base {
 
-	/** @var IRootFolder */
-	protected $root;
-	/** @var IConfig */
-	protected $config;
-	/** @var float */
-	protected $execTime = 0;
-	/** @var int */
-	protected $foldersCounter = 0;
-	/** @var int */
-	protected $filesCounter = 0;
-
-	public function __construct(IRootFolder $rootFolder, IConfig $config) {
-		parent::__construct();
-
-		$this->root = $rootFolder;
-		$this->config = $config;
-	}
-
-	protected function configure() {
-		parent::configure();
-
-		$this
-			->setName('files:scan-app-data')
-			->setDescription('rescan the AppData folder')
-			->addOption(
-				'quiet',
-				'q',
-				InputOption::VALUE_NONE,
-				'suppress any output'
-			)
-			->addOption(
-				'verbose',
-				'-v|vv|vvv',
-				InputOption::VALUE_NONE,
-				'verbose the output'
-			);
-	}
-
-	public function checkScanWarning($fullPath, OutputInterface $output) {
-		$normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
-		$path = basename($fullPath);
-
-		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
-		}
-	}
-
-	protected function scanFiles($verbose, OutputInterface $output) {
-		try {
-			$appData = $this->getAppDataFolder();
-		} catch (NotFoundException $e) {
-			$output->writeln('NoAppData folder found');
-			return;
-		}
-
-		$connection = $this->reconnectToDatabase($output);
-		$scanner = new \OC\Files\Utils\Scanner(null, $connection, \OC::$server->getLogger());
-		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
-		# printout and count
-		if ($verbose) {
-			$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();
-				}
-			});
-			$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();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$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();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
-				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-		}
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-
-		try {
-			$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");
-		} catch (InterruptedException $e) {
-			# exit the function if ctrl-c has been pressed
-			$output->writeln('Interrupted by user');
-		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
-		}
-	}
-
-
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		# no messaging level option means: no full printout but statistics
-		# $quiet   means no print at all
-		# $verbose means full printout including statistics
-		# -q	-v	full	stat
-		#  0	 0	no	yes
-		#  0	 1	yes	yes
-		#  1	--	no	no  (quiet overrules verbose)
-		$verbose = $input->getOption('verbose');
-		$quiet = $input->getOption('quiet');
-		# restrict the verbosity level to VERBOSITY_VERBOSE
-		if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
-			$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
-		}
-		if ($quiet) {
-			$verbose = false;
-		}
-
-		$output->writeln("\nScanning AppData for files");
-
-		$this->initTools();
-
-		$this->scanFiles($verbose, $output);
-
-		# stat: printout statistics if $quiet was not set
-		if (!$quiet) {
-			$this->presentStats($output);
-		}
-	}
-
-	/**
-	 * Initialises some useful tools for the Command
-	 */
-	protected function initTools() {
-		// Start the timer
-		$this->execTime = -microtime(true);
-		// Convert PHP errors to exceptions
-		set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
-	}
-
-	/**
-	 * Processes PHP errors as exceptions in order to be able to keep track of problems
-	 *
-	 * @see https://secure.php.net/manual/en/function.set-error-handler.php
-	 *
-	 * @param int $severity the level of the error raised
-	 * @param string $message
-	 * @param string $file the filename that the error was raised in
-	 * @param int $line the line number the error was raised
-	 *
-	 * @throws \ErrorException
-	 */
-	public function exceptionErrorHandler($severity, $message, $file, $line) {
-		if (!(error_reporting() & $severity)) {
-			// This error code is not included in error_reporting
-			return;
-		}
-		throw new \ErrorException($message, 0, $severity, $file, $line);
-	}
-
-	/**
-	 * @param OutputInterface $output
-	 */
-	protected function presentStats(OutputInterface $output) {
-		// Stop the timer
-		$this->execTime += microtime(true);
-		$output->writeln("");
-
-		$headers = [
-			'Folders', 'Files', 'Elapsed time'
-		];
-
-		$this->showSummary($headers, null, $output);
-	}
-
-	/**
-	 * Shows a summary of operations
-	 *
-	 * @param string[] $headers
-	 * @param string[] $rows
-	 * @param OutputInterface $output
-	 */
-	protected function showSummary($headers, $rows, OutputInterface $output) {
-		$niceDate = $this->formatExecTime();
-		if (!$rows) {
-			$rows = [
-				$this->foldersCounter,
-				$this->filesCounter,
-				$niceDate,
-			];
-		}
-		$table = new Table($output);
-		$table
-			->setHeaders($headers)
-			->setRows([$rows]);
-		$table->render();
-	}
-
-
-	/**
-	 * Formats microtime into a human readable format
-	 *
-	 * @return string
-	 */
-	protected function formatExecTime() {
-		list($secs, $tens) = explode('.', sprintf("%.1f", ($this->execTime)));
-
-		# if you want to have microseconds add this:   . '.' . $tens;
-		return date('H:i:s', $secs);
-	}
-
-	/**
-	 * @return \OCP\IDBConnection
-	 */
-	protected function reconnectToDatabase(OutputInterface $output) {
-		/** @var Connection | IDBConnection $connection*/
-		$connection = \OC::$server->getDatabaseConnection();
-		try {
-			$connection->close();
-		} catch (\Exception $ex) {
-			$output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
-		}
-		while (!$connection->isConnected()) {
-			try {
-				$connection->connect();
-			} catch (\Exception $ex) {
-				$output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
-				sleep(60);
-			}
-		}
-		return $connection;
-	}
-
-	/**
-	 * @return \OCP\Files\Folder
-	 * @throws NotFoundException
-	 */
-	private function getAppDataFolder() {
-		$instanceId = $this->config->getSystemValue('instanceid', null);
-
-		if ($instanceId === null) {
-			throw new NotFoundException();
-		}
-
-		return $this->root->get('appdata_'.$instanceId);
-	}
+    /** @var IRootFolder */
+    protected $root;
+    /** @var IConfig */
+    protected $config;
+    /** @var float */
+    protected $execTime = 0;
+    /** @var int */
+    protected $foldersCounter = 0;
+    /** @var int */
+    protected $filesCounter = 0;
+
+    public function __construct(IRootFolder $rootFolder, IConfig $config) {
+        parent::__construct();
+
+        $this->root = $rootFolder;
+        $this->config = $config;
+    }
+
+    protected function configure() {
+        parent::configure();
+
+        $this
+            ->setName('files:scan-app-data')
+            ->setDescription('rescan the AppData folder')
+            ->addOption(
+                'quiet',
+                'q',
+                InputOption::VALUE_NONE,
+                'suppress any output'
+            )
+            ->addOption(
+                'verbose',
+                '-v|vv|vvv',
+                InputOption::VALUE_NONE,
+                'verbose the output'
+            );
+    }
+
+    public function checkScanWarning($fullPath, OutputInterface $output) {
+        $normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
+        $path = basename($fullPath);
+
+        if ($normalizedPath !== $path) {
+            $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+        }
+    }
+
+    protected function scanFiles($verbose, OutputInterface $output) {
+        try {
+            $appData = $this->getAppDataFolder();
+        } catch (NotFoundException $e) {
+            $output->writeln('NoAppData folder found');
+            return;
+        }
+
+        $connection = $this->reconnectToDatabase($output);
+        $scanner = new \OC\Files\Utils\Scanner(null, $connection, \OC::$server->getLogger());
+        # check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
+        # printout and count
+        if ($verbose) {
+            $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();
+                }
+            });
+            $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();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
+                $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();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
+                $this->foldersCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+        }
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+
+        try {
+            $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");
+        } catch (InterruptedException $e) {
+            # exit the function if ctrl-c has been pressed
+            $output->writeln('Interrupted by user');
+        } catch (\Exception $e) {
+            $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
+            $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+        }
+    }
+
+
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        # no messaging level option means: no full printout but statistics
+        # $quiet   means no print at all
+        # $verbose means full printout including statistics
+        # -q	-v	full	stat
+        #  0	 0	no	yes
+        #  0	 1	yes	yes
+        #  1	--	no	no  (quiet overrules verbose)
+        $verbose = $input->getOption('verbose');
+        $quiet = $input->getOption('quiet');
+        # restrict the verbosity level to VERBOSITY_VERBOSE
+        if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
+            $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
+        }
+        if ($quiet) {
+            $verbose = false;
+        }
+
+        $output->writeln("\nScanning AppData for files");
+
+        $this->initTools();
+
+        $this->scanFiles($verbose, $output);
+
+        # stat: printout statistics if $quiet was not set
+        if (!$quiet) {
+            $this->presentStats($output);
+        }
+    }
+
+    /**
+     * Initialises some useful tools for the Command
+     */
+    protected function initTools() {
+        // Start the timer
+        $this->execTime = -microtime(true);
+        // Convert PHP errors to exceptions
+        set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
+    }
+
+    /**
+     * Processes PHP errors as exceptions in order to be able to keep track of problems
+     *
+     * @see https://secure.php.net/manual/en/function.set-error-handler.php
+     *
+     * @param int $severity the level of the error raised
+     * @param string $message
+     * @param string $file the filename that the error was raised in
+     * @param int $line the line number the error was raised
+     *
+     * @throws \ErrorException
+     */
+    public function exceptionErrorHandler($severity, $message, $file, $line) {
+        if (!(error_reporting() & $severity)) {
+            // This error code is not included in error_reporting
+            return;
+        }
+        throw new \ErrorException($message, 0, $severity, $file, $line);
+    }
+
+    /**
+     * @param OutputInterface $output
+     */
+    protected function presentStats(OutputInterface $output) {
+        // Stop the timer
+        $this->execTime += microtime(true);
+        $output->writeln("");
+
+        $headers = [
+            'Folders', 'Files', 'Elapsed time'
+        ];
+
+        $this->showSummary($headers, null, $output);
+    }
+
+    /**
+     * Shows a summary of operations
+     *
+     * @param string[] $headers
+     * @param string[] $rows
+     * @param OutputInterface $output
+     */
+    protected function showSummary($headers, $rows, OutputInterface $output) {
+        $niceDate = $this->formatExecTime();
+        if (!$rows) {
+            $rows = [
+                $this->foldersCounter,
+                $this->filesCounter,
+                $niceDate,
+            ];
+        }
+        $table = new Table($output);
+        $table
+            ->setHeaders($headers)
+            ->setRows([$rows]);
+        $table->render();
+    }
+
+
+    /**
+     * Formats microtime into a human readable format
+     *
+     * @return string
+     */
+    protected function formatExecTime() {
+        list($secs, $tens) = explode('.', sprintf("%.1f", ($this->execTime)));
+
+        # if you want to have microseconds add this:   . '.' . $tens;
+        return date('H:i:s', $secs);
+    }
+
+    /**
+     * @return \OCP\IDBConnection
+     */
+    protected function reconnectToDatabase(OutputInterface $output) {
+        /** @var Connection | IDBConnection $connection*/
+        $connection = \OC::$server->getDatabaseConnection();
+        try {
+            $connection->close();
+        } catch (\Exception $ex) {
+            $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
+        }
+        while (!$connection->isConnected()) {
+            try {
+                $connection->connect();
+            } catch (\Exception $ex) {
+                $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
+                sleep(60);
+            }
+        }
+        return $connection;
+    }
+
+    /**
+     * @return \OCP\Files\Folder
+     * @throws NotFoundException
+     */
+    private function getAppDataFolder() {
+        $instanceId = $this->config->getSystemValue('instanceid', null);
+
+        if ($instanceId === null) {
+            throw new NotFoundException();
+        }
+
+        return $this->root->get('appdata_'.$instanceId);
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -64,7 +64,7 @@ 
 		$path = basename($fullPath);
 
 		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+			$output->writeln("\t<error>Entry \"".$fullPath.'" will not be accessible due to incompatible encoding</error>');
 		}
 	}
 
@@ -81,32 +81,32 @@ 
 		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
 		# printout and count
 		if ($verbose) {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+			$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();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+			$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();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function(StorageNotAvailableException $e) use ($output) {
+				$output->writeln("Error while scanning, storage not available (".$e->getMessage().")");
 			});
 			# count only
 		} else {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function() use ($output) {
 				$this->filesCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function() use ($output) {
 				$this->foldersCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
@@ -129,8 +129,8 @@ 
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');
 		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+			$output->writeln('<error>Exception during scan: '.$e->getMessage().'</error>');
+			$output->writeln('<error>'.$e->getTraceAsString().'</error>');
 		}
 	}