Inspection of "show error when trying to scan non existing path" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4396)

by Robin

created 2017-04-19 12:38 UTC

Status

Indentation +281 added lines, -281 removed lines patch added patch discarded remove patch

@@ -44,310 +44,310 @@
 block discarded – undo
 
 class Scan extends Base {
 
-	/** @var IUserManager $userManager */
-	private $userManager;
-	/** @var float */
-	protected $execTime = 0;
-	/** @var int */
-	protected $foldersCounter = 0;
-	/** @var int */
-	protected $filesCounter = 0;
+    /** @var IUserManager $userManager */
+    private $userManager;
+    /** @var float */
+    protected $execTime = 0;
+    /** @var int */
+    protected $foldersCounter = 0;
+    /** @var int */
+    protected $filesCounter = 0;
 
-	public function __construct(IUserManager $userManager) {
-		$this->userManager = $userManager;
-		parent::__construct();
-	}
+    public function __construct(IUserManager $userManager) {
+        $this->userManager = $userManager;
+        parent::__construct();
+    }
 
-	protected function configure() {
-		parent::configure();
+    protected function configure() {
+        parent::configure();
 
-		$this
-			->setName('files:scan')
-			->setDescription('rescan filesystem')
-			->addArgument(
-				'user_id',
-				InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-				'will rescan all files of the given user(s)'
-			)
-			->addOption(
-				'path',
-				'p',
-				InputArgument::OPTIONAL,
-				'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
-			)
-			->addOption(
-				'quiet',
-				'q',
-				InputOption::VALUE_NONE,
-				'suppress any output'
-			)
-			->addOption(
-				'verbose',
-				'-v|vv|vvv',
-				InputOption::VALUE_NONE,
-				'verbose the output'
-			)
-			->addOption(
-				'all',
-				null,
-				InputOption::VALUE_NONE,
-				'will rescan all files of all known users'
-			)->addOption(
-				'unscanned',
-				null,
-				InputOption::VALUE_NONE,
-				'only scan files which are marked as not fully scanned'
-			);
-	}
+        $this
+            ->setName('files:scan')
+            ->setDescription('rescan filesystem')
+            ->addArgument(
+                'user_id',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'will rescan all files of the given user(s)'
+            )
+            ->addOption(
+                'path',
+                'p',
+                InputArgument::OPTIONAL,
+                'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
+            )
+            ->addOption(
+                'quiet',
+                'q',
+                InputOption::VALUE_NONE,
+                'suppress any output'
+            )
+            ->addOption(
+                'verbose',
+                '-v|vv|vvv',
+                InputOption::VALUE_NONE,
+                'verbose the output'
+            )
+            ->addOption(
+                'all',
+                null,
+                InputOption::VALUE_NONE,
+                'will rescan all files of all known users'
+            )->addOption(
+                'unscanned',
+                null,
+                InputOption::VALUE_NONE,
+                'only scan files which are marked as not fully scanned'
+            );
+    }
 
-	public function checkScanWarning($fullPath, OutputInterface $output) {
-		$normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
-		$path = basename($fullPath);
+    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>');
-		}
-	}
+        if ($normalizedPath !== $path) {
+            $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+        }
+    }
 
-	protected function scanFiles($user, $path, $verbose, OutputInterface $output, $backgroundScan = false) {
-		$connection = $this->reconnectToDatabase($output);
-		$scanner = new \OC\Files\Utils\Scanner($user, $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);
-		});
+    protected function scanFiles($user, $path, $verbose, OutputInterface $output, $backgroundScan = false) {
+        $connection = $this->reconnectToDatabase($output);
+        $scanner = new \OC\Files\Utils\Scanner($user, $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 {
-			if ($backgroundScan) {
-				$scanner->backgroundScan($path);
-			} else {
-				$scanner->scan($path);
-			}
-		} 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");
-		} catch (InterruptedException $e) {
-			# exit the function if ctrl-c has been pressed
-			$output->writeln('Interrupted by user');
-		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
-		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
-		}
-	}
+        try {
+            if ($backgroundScan) {
+                $scanner->backgroundScan($path);
+            } else {
+                $scanner->scan($path);
+            }
+        } 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");
+        } catch (InterruptedException $e) {
+            # exit the function if ctrl-c has been pressed
+            $output->writeln('Interrupted by user');
+        } catch (NotFoundException $e) {
+            $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+        } 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) {
-		$inputPath = $input->getOption('path');
-		if ($inputPath) {
-			$inputPath = '/' . trim($inputPath, '/');
-			list (, $user,) = explode('/', $inputPath, 3);
-			$users = array($user);
-		} else if ($input->getOption('all')) {
-			$users = $this->userManager->search('');
-		} else {
-			$users = $input->getArgument('user_id');
-		}
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $inputPath = $input->getOption('path');
+        if ($inputPath) {
+            $inputPath = '/' . trim($inputPath, '/');
+            list (, $user,) = explode('/', $inputPath, 3);
+            $users = array($user);
+        } else if ($input->getOption('all')) {
+            $users = $this->userManager->search('');
+        } else {
+            $users = $input->getArgument('user_id');
+        }
 
-		# 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;
-		}
+        # 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;
+        }
 
-		# check quantity of users to be process and show it on the command line
-		$users_total = count($users);
-		if ($users_total === 0) {
-			$output->writeln("<error>Please specify the user id to scan, \"--all\" to scan for all users or \"--path=...\"</error>");
-			return;
-		} else {
-			if ($users_total > 1) {
-				$output->writeln("\nScanning files for $users_total users");
-			}
-		}
+        # check quantity of users to be process and show it on the command line
+        $users_total = count($users);
+        if ($users_total === 0) {
+            $output->writeln("<error>Please specify the user id to scan, \"--all\" to scan for all users or \"--path=...\"</error>");
+            return;
+        } else {
+            if ($users_total > 1) {
+                $output->writeln("\nScanning files for $users_total users");
+            }
+        }
 
-		$this->initTools();
+        $this->initTools();
 
-		$user_count = 0;
-		foreach ($users as $user) {
-			if (is_object($user)) {
-				$user = $user->getUID();
-			}
-			$path = $inputPath ? $inputPath : '/' . $user;
-			$user_count += 1;
-			if ($this->userManager->userExists($user)) {
-				# add an extra line when verbose is set to optical separate users
-				if ($verbose) {
-					$output->writeln("");
-				}
-				$output->writeln("Starting scan for user $user_count out of $users_total ($user)");
-				# full: printout data if $verbose was set
-				$this->scanFiles($user, $path, $verbose, $output, $input->getOption('unscanned'));
-			} 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()) {
-				break;
-			}
-		}
+        $user_count = 0;
+        foreach ($users as $user) {
+            if (is_object($user)) {
+                $user = $user->getUID();
+            }
+            $path = $inputPath ? $inputPath : '/' . $user;
+            $user_count += 1;
+            if ($this->userManager->userExists($user)) {
+                # add an extra line when verbose is set to optical separate users
+                if ($verbose) {
+                    $output->writeln("");
+                }
+                $output->writeln("Starting scan for user $user_count out of $users_total ($user)");
+                # full: printout data if $verbose was set
+                $this->scanFiles($user, $path, $verbose, $output, $input->getOption('unscanned'));
+            } 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()) {
+                break;
+            }
+        }
 
-		# stat: printout statistics if $quiet was not set
-		if (!$quiet) {
-			$this->presentStats($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);
-	}
+    /**
+     * 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);
-	}
+    /**
+     * 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("");
+    /**
+     * @param OutputInterface $output
+     */
+    protected function presentStats(OutputInterface $output) {
+        // Stop the timer
+        $this->execTime += microtime(true);
+        $output->writeln("");
 
-		$headers = [
-			'Folders', 'Files', 'Elapsed time'
-		];
+        $headers = [
+            'Folders', 'Files', 'Elapsed time'
+        ];
 
-		$this->showSummary($headers, null, $output);
-	}
+        $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();
-	}
+    /**
+     * 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)));
+    /**
+     * 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);
-	}
+        # 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\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;
+    }
 
 }

Please login to merge, or discard this patch.

Spacing +14 added lines, -14 removed lines patch added patch discarded remove patch

@@ -105,7 +105,7 @@  discard block
 block discarded – undo
 		$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>');
 		}
 	}
 
@@ -115,42 +115,42 @@  discard block
 block discarded – undo
 		# 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();
 				}
 			});
 		}
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+		$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) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
 			$this->checkScanWarning($path, $output);
 		});
 
@@ -167,10 +167,10 @@  discard block
 block discarded – undo
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');
 		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+			$output->writeln('<error>Path not found: '.$e->getMessage().'</error>');
 		} 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>');
 		}
 	}
 
@@ -178,7 +178,7 @@  discard block
 block discarded – undo
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$inputPath = $input->getOption('path');
 		if ($inputPath) {
-			$inputPath = '/' . trim($inputPath, '/');
+			$inputPath = '/'.trim($inputPath, '/');
 			list (, $user,) = explode('/', $inputPath, 3);
 			$users = array($user);
 		} else if ($input->getOption('all')) {
@@ -222,7 +222,7 @@  discard block
 block discarded – undo
 			if (is_object($user)) {
 				$user = $user->getUID();
 			}
-			$path = $inputPath ? $inputPath : '/' . $user;
+			$path = $inputPath ? $inputPath : '/'.$user;
 			$user_count += 1;
 			if ($this->userManager->userExists($user)) {
 				# add an extra line when verbose is set to optical separate users

Please login to merge, or discard this patch.

lib/private/Files/Utils/Scanner.php 1 patch

Indentation +194 added lines, -194 removed lines patch added patch discarded remove patch

@@ -47,199 +47,199 @@
 block discarded – undo
  * @package OC\Files\Utils
  */
 class Scanner extends PublicEmitter {
-	/**
-	 * @var string $user
-	 */
-	private $user;
-
-	/**
-	 * @var \OCP\IDBConnection
-	 */
-	protected $db;
-
-	/**
-	 * @var ILogger
-	 */
-	protected $logger;
-
-	/**
-	 * @param string $user
-	 * @param \OCP\IDBConnection $db
-	 * @param ILogger $logger
-	 */
-	public function __construct($user, $db, ILogger $logger) {
-		$this->logger = $logger;
-		$this->user = $user;
-		$this->db = $db;
-	}
-
-	/**
-	 * get all storages for $dir
-	 *
-	 * @param string $dir
-	 * @return \OC\Files\Mount\MountPoint[]
-	 */
-	protected function getMounts($dir) {
-		//TODO: move to the node based fileapi once that's done
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($this->user);
-
-		$mountManager = Filesystem::getMountManager();
-		$mounts = $mountManager->findIn($dir);
-		$mounts[] = $mountManager->find($dir);
-		$mounts = array_reverse($mounts); //start with the mount of $dir
-
-		return $mounts;
-	}
-
-	/**
-	 * attach listeners to the scanner
-	 *
-	 * @param \OC\Files\Mount\MountPoint $mount
-	 */
-	protected function attachListener($mount) {
-		$scanner = $mount->getStorage()->getScanner();
-		$emitter = $this;
-		$scanner->listen('\OC\Files\Cache\Scanner', 'scanFile', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'scanFile', array($mount->getMountPoint() . $path));
-		});
-		$scanner->listen('\OC\Files\Cache\Scanner', 'scanFolder', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'scanFolder', array($mount->getMountPoint() . $path));
-		});
-		$scanner->listen('\OC\Files\Cache\Scanner', 'postScanFile', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'postScanFile', array($mount->getMountPoint() . $path));
-		});
-		$scanner->listen('\OC\Files\Cache\Scanner', 'postScanFolder', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'postScanFolder', array($mount->getMountPoint() . $path));
-		});
-	}
-
-	/**
-	 * @param string $dir
-	 */
-	public function backgroundScan($dir) {
-		$mounts = $this->getMounts($dir);
-		foreach ($mounts as $mount) {
-			$storage = $mount->getStorage();
-			if (is_null($storage)) {
-				continue;
-			}
-
-			// don't bother scanning failed storages (shortcut for same result)
-			if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
-				continue;
-			}
-
-			// don't scan the root storage
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Local') && $mount->getMountPoint() === '/') {
-				continue;
-			}
-
-			// don't scan received local shares, these can be scanned when scanning the owner's storage
-			if ($storage->instanceOfStorage(SharedStorage::class)) {
-				continue;
-			}
-			$scanner = $storage->getScanner();
-			$this->attachListener($mount);
-
-			$scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-
-			$propagator = $storage->getPropagator();
-			$propagator->beginBatch();
-			$scanner->backgroundScan();
-			$propagator->commitBatch();
-		}
-	}
-
-	/**
-	 * @param string $dir
-	 * @throws \OC\ForbiddenException
-	 */
-	public function scan($dir = '') {
-		if (!Filesystem::isValidPath($dir)) {
-			throw new \InvalidArgumentException('Invalid path to scan');
-		}
-		$mounts = $this->getMounts($dir);
-		foreach ($mounts as $mount) {
-			$storage = $mount->getStorage();
-			if (is_null($storage)) {
-				continue;
-			}
-
-			// don't bother scanning failed storages (shortcut for same result)
-			if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
-				continue;
-			}
-
-			// if the home storage isn't writable then the scanner is run as the wrong user
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home') and
-				(!$storage->isCreatable('') or !$storage->isCreatable('files'))
-			) {
-				if ($storage->file_exists('') or $storage->getCache()->inCache('')) {
-					throw new ForbiddenException();
-				} else {// if the root exists in neither the cache nor the storage the user isn't setup yet
-					break;
-				}
-
-			}
-
-			// don't scan received local shares, these can be scanned when scanning the owner's storage
-			if ($storage->instanceOfStorage(SharedStorage::class)) {
-				continue;
-			}
-			$relativePath = $mount->getInternalPath($dir);
-			$scanner = $storage->getScanner();
-			$scanner->setUseTransactions(false);
-			$this->attachListener($mount);
-			$isDbLocking = \OC::$server->getLockingProvider() instanceof DBLockingProvider;
-
-			$scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-
-			if (!$isDbLocking) {
-				$this->db->beginTransaction();
-			}
-			try {
-				$propagator = $storage->getPropagator();
-				$propagator->beginBatch();
-				if (!$storage->file_exists($relativePath)) {
-					throw new NotFoundException($dir);
-				}
-				$scanner->scan($relativePath, \OC\Files\Cache\Scanner::SCAN_RECURSIVE, \OC\Files\Cache\Scanner::REUSE_ETAG | \OC\Files\Cache\Scanner::REUSE_SIZE);
-				$cache = $storage->getCache();
-				if ($cache instanceof Cache) {
-					// only re-calculate for the root folder we scanned, anything below that is taken care of by the scanner
-					$cache->correctFolderSize($relativePath);
-				}
-				$propagator->commitBatch();
-			} catch (StorageNotAvailableException $e) {
-				$this->logger->error('Storage ' . $storage->getId() . ' not available');
-				$this->logger->logException($e);
-				$this->emit('\OC\Files\Utils\Scanner', 'StorageNotAvailable', [$e]);
-			}
-			if (!$isDbLocking) {
-				$this->db->commit();
-			}
-		}
-	}
-
-	private function triggerPropagator(IStorage $storage, $internalPath) {
-		$storage->getPropagator()->propagateChange($internalPath, time());
-	}
+    /**
+     * @var string $user
+     */
+    private $user;
+
+    /**
+     * @var \OCP\IDBConnection
+     */
+    protected $db;
+
+    /**
+     * @var ILogger
+     */
+    protected $logger;
+
+    /**
+     * @param string $user
+     * @param \OCP\IDBConnection $db
+     * @param ILogger $logger
+     */
+    public function __construct($user, $db, ILogger $logger) {
+        $this->logger = $logger;
+        $this->user = $user;
+        $this->db = $db;
+    }
+
+    /**
+     * get all storages for $dir
+     *
+     * @param string $dir
+     * @return \OC\Files\Mount\MountPoint[]
+     */
+    protected function getMounts($dir) {
+        //TODO: move to the node based fileapi once that's done
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($this->user);
+
+        $mountManager = Filesystem::getMountManager();
+        $mounts = $mountManager->findIn($dir);
+        $mounts[] = $mountManager->find($dir);
+        $mounts = array_reverse($mounts); //start with the mount of $dir
+
+        return $mounts;
+    }
+
+    /**
+     * attach listeners to the scanner
+     *
+     * @param \OC\Files\Mount\MountPoint $mount
+     */
+    protected function attachListener($mount) {
+        $scanner = $mount->getStorage()->getScanner();
+        $emitter = $this;
+        $scanner->listen('\OC\Files\Cache\Scanner', 'scanFile', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'scanFile', array($mount->getMountPoint() . $path));
+        });
+        $scanner->listen('\OC\Files\Cache\Scanner', 'scanFolder', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'scanFolder', array($mount->getMountPoint() . $path));
+        });
+        $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFile', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFile', array($mount->getMountPoint() . $path));
+        });
+        $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFolder', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFolder', array($mount->getMountPoint() . $path));
+        });
+    }
+
+    /**
+     * @param string $dir
+     */
+    public function backgroundScan($dir) {
+        $mounts = $this->getMounts($dir);
+        foreach ($mounts as $mount) {
+            $storage = $mount->getStorage();
+            if (is_null($storage)) {
+                continue;
+            }
+
+            // don't bother scanning failed storages (shortcut for same result)
+            if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
+                continue;
+            }
+
+            // don't scan the root storage
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Local') && $mount->getMountPoint() === '/') {
+                continue;
+            }
+
+            // don't scan received local shares, these can be scanned when scanning the owner's storage
+            if ($storage->instanceOfStorage(SharedStorage::class)) {
+                continue;
+            }
+            $scanner = $storage->getScanner();
+            $this->attachListener($mount);
+
+            $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+
+            $propagator = $storage->getPropagator();
+            $propagator->beginBatch();
+            $scanner->backgroundScan();
+            $propagator->commitBatch();
+        }
+    }
+
+    /**
+     * @param string $dir
+     * @throws \OC\ForbiddenException
+     */
+    public function scan($dir = '') {
+        if (!Filesystem::isValidPath($dir)) {
+            throw new \InvalidArgumentException('Invalid path to scan');
+        }
+        $mounts = $this->getMounts($dir);
+        foreach ($mounts as $mount) {
+            $storage = $mount->getStorage();
+            if (is_null($storage)) {
+                continue;
+            }
+
+            // don't bother scanning failed storages (shortcut for same result)
+            if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
+                continue;
+            }
+
+            // if the home storage isn't writable then the scanner is run as the wrong user
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home') and
+                (!$storage->isCreatable('') or !$storage->isCreatable('files'))
+            ) {
+                if ($storage->file_exists('') or $storage->getCache()->inCache('')) {
+                    throw new ForbiddenException();
+                } else {// if the root exists in neither the cache nor the storage the user isn't setup yet
+                    break;
+                }
+
+            }
+
+            // don't scan received local shares, these can be scanned when scanning the owner's storage
+            if ($storage->instanceOfStorage(SharedStorage::class)) {
+                continue;
+            }
+            $relativePath = $mount->getInternalPath($dir);
+            $scanner = $storage->getScanner();
+            $scanner->setUseTransactions(false);
+            $this->attachListener($mount);
+            $isDbLocking = \OC::$server->getLockingProvider() instanceof DBLockingProvider;
+
+            $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+
+            if (!$isDbLocking) {
+                $this->db->beginTransaction();
+            }
+            try {
+                $propagator = $storage->getPropagator();
+                $propagator->beginBatch();
+                if (!$storage->file_exists($relativePath)) {
+                    throw new NotFoundException($dir);
+                }
+                $scanner->scan($relativePath, \OC\Files\Cache\Scanner::SCAN_RECURSIVE, \OC\Files\Cache\Scanner::REUSE_ETAG | \OC\Files\Cache\Scanner::REUSE_SIZE);
+                $cache = $storage->getCache();
+                if ($cache instanceof Cache) {
+                    // only re-calculate for the root folder we scanned, anything below that is taken care of by the scanner
+                    $cache->correctFolderSize($relativePath);
+                }
+                $propagator->commitBatch();
+            } catch (StorageNotAvailableException $e) {
+                $this->logger->error('Storage ' . $storage->getId() . ' not available');
+                $this->logger->logException($e);
+                $this->emit('\OC\Files\Utils\Scanner', 'StorageNotAvailable', [$e]);
+            }
+            if (!$isDbLocking) {
+                $this->db->commit();
+            }
+        }
+    }
+
+    private function triggerPropagator(IStorage $storage, $internalPath) {
+        $storage->getPropagator()->propagateChange($internalPath, time());
+    }
 }
 

Please login to merge, or discard this patch.

		@@ -105,7 +105,7 @@ discard block
		block discarded – undo
105	105	$path = basename($fullPath);
106	106
107	107	if ($normalizedPath !== $path) {
108		- $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
	108	+ $output->writeln("\t<error>Entry \"".$fullPath.'" will not be accessible due to incompatible encoding</error>');
109	109	}
110	110	}
111	111
		@@ -115,42 +115,42 @@ discard block
		block discarded – undo
115	115	# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
116	116	# printout and count
117	117	if ($verbose) {
118		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
	118	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
119	119	$output->writeln("\tFile <info>$path</info>");
120	120	$this->filesCounter += 1;
121	121	if ($this->hasBeenInterrupted()) {
122	122	throw new InterruptedException();
123	123	}
124	124	});
125		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
	125	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
126	126	$output->writeln("\tFolder <info>$path</info>");
127	127	$this->foldersCounter += 1;
128	128	if ($this->hasBeenInterrupted()) {
129	129	throw new InterruptedException();
130	130	}
131	131	});
132		- $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
133		- $output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
	132	+ $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function(StorageNotAvailableException $e) use ($output) {
	133	+ $output->writeln("Error while scanning, storage not available (".$e->getMessage().")");
134	134	});
135	135	# count only
136	136	} else {
137		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
	137	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function() use ($output) {
138	138	$this->filesCounter += 1;
139	139	if ($this->hasBeenInterrupted()) {
140	140	throw new InterruptedException();
141	141	}
142	142	});
143		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
	143	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function() use ($output) {
144	144	$this->foldersCounter += 1;
145	145	if ($this->hasBeenInterrupted()) {
146	146	throw new InterruptedException();
147	147	}
148	148	});
149	149	}
150		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
	150	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
151	151	$this->checkScanWarning($path, $output);
152	152	});
153		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
	153	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
154	154	$this->checkScanWarning($path, $output);
155	155	});
156	156
		@@ -167,10 +167,10 @@ discard block
		block discarded – undo
167	167	# exit the function if ctrl-c has been pressed
168	168	$output->writeln('Interrupted by user');
169	169	} catch (NotFoundException $e) {
170		- $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
	170	+ $output->writeln('<error>Path not found: '.$e->getMessage().'</error>');
171	171	} catch (\Exception $e) {
172		- $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
173		- $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
	172	+ $output->writeln('<error>Exception during scan: '.$e->getMessage().'</error>');
	173	+ $output->writeln('<error>'.$e->getTraceAsString().'</error>');
174	174	}
175	175	}
176	176
		@@ -178,7 +178,7 @@ discard block
		block discarded – undo
178	178	protected function execute(InputInterface $input, OutputInterface $output) {
179	179	$inputPath = $input->getOption('path');
180	180	if ($inputPath) {
181		- $inputPath = '/' . trim($inputPath, '/');
	181	+ $inputPath = '/'.trim($inputPath, '/');
182	182	list (, $user,) = explode('/', $inputPath, 3);
183	183	$users = array($user);
184	184	} else if ($input->getOption('all')) {
		@@ -222,7 +222,7 @@ discard block
		block discarded – undo
222	222	if (is_object($user)) {
223	223	$user = $user->getUID();
224	224	}
225		- $path = $inputPath ? $inputPath : '/' . $user;
	225	+ $path = $inputPath ? $inputPath : '/'.$user;
226	226	$user_count += 1;
227	227	if ($this->userManager->userExists($user)) {
228	228	# add an extra line when verbose is set to optical separate users

		@@ -44,310 +44,310 @@
		block discarded – undo
44	44
45	45	class Scan extends Base {
46	46
47		- /** @var IUserManager $userManager */
48		- private $userManager;
49		- /** @var float */
50		- protected $execTime = 0;
51		- /** @var int */
52		- protected $foldersCounter = 0;
53		- /** @var int */
54		- protected $filesCounter = 0;
	47	+ /** @var IUserManager $userManager */
	48	+ private $userManager;
	49	+ /** @var float */
	50	+ protected $execTime = 0;
	51	+ /** @var int */
	52	+ protected $foldersCounter = 0;
	53	+ /** @var int */
	54	+ protected $filesCounter = 0;
55	55
56		- public function __construct(IUserManager $userManager) {
57		- $this->userManager = $userManager;
58		- parent::__construct();
59		- }
	56	+ public function __construct(IUserManager $userManager) {
	57	+ $this->userManager = $userManager;
	58	+ parent::__construct();
	59	+ }
60	60
61		- protected function configure() {
62		- parent::configure();
	61	+ protected function configure() {
	62	+ parent::configure();
63	63
64		- $this
65		- ->setName('files:scan')
66		- ->setDescription('rescan filesystem')
67		- ->addArgument(
68		- 'user_id',
69		- InputArgument::OPTIONAL \| InputArgument::IS_ARRAY,
70		- 'will rescan all files of the given user(s)'
71		- )
72		- ->addOption(
73		- 'path',
74		- 'p',
75		- InputArgument::OPTIONAL,
76		- 'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
77		- )
78		- ->addOption(
79		- 'quiet',
80		- 'q',
81		- InputOption::VALUE_NONE,
82		- 'suppress any output'
83		- )
84		- ->addOption(
85		- 'verbose',
86		- '-v\|vv\|vvv',
87		- InputOption::VALUE_NONE,
88		- 'verbose the output'
89		- )
90		- ->addOption(
91		- 'all',
92		- null,
93		- InputOption::VALUE_NONE,
94		- 'will rescan all files of all known users'
95		- )->addOption(
96		- 'unscanned',
97		- null,
98		- InputOption::VALUE_NONE,
99		- 'only scan files which are marked as not fully scanned'
100		- );
101		- }
	64	+ $this
	65	+ ->setName('files:scan')
	66	+ ->setDescription('rescan filesystem')
	67	+ ->addArgument(
	68	+ 'user_id',
	69	+ InputArgument::OPTIONAL \| InputArgument::IS_ARRAY,
	70	+ 'will rescan all files of the given user(s)'
	71	+ )
	72	+ ->addOption(
	73	+ 'path',
	74	+ 'p',
	75	+ InputArgument::OPTIONAL,
	76	+ 'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
	77	+ )
	78	+ ->addOption(
	79	+ 'quiet',
	80	+ 'q',
	81	+ InputOption::VALUE_NONE,
	82	+ 'suppress any output'
	83	+ )
	84	+ ->addOption(
	85	+ 'verbose',
	86	+ '-v\|vv\|vvv',
	87	+ InputOption::VALUE_NONE,
	88	+ 'verbose the output'
	89	+ )
	90	+ ->addOption(
	91	+ 'all',
	92	+ null,
	93	+ InputOption::VALUE_NONE,
	94	+ 'will rescan all files of all known users'
	95	+ )->addOption(
	96	+ 'unscanned',
	97	+ null,
	98	+ InputOption::VALUE_NONE,
	99	+ 'only scan files which are marked as not fully scanned'
	100	+ );
	101	+ }
102	102
103		- public function checkScanWarning($fullPath, OutputInterface $output) {
104		- $normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
105		- $path = basename($fullPath);
	103	+ public function checkScanWarning($fullPath, OutputInterface $output) {
	104	+ $normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
	105	+ $path = basename($fullPath);
106	106
107		- if ($normalizedPath !== $path) {
108		- $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
109		- }
110		- }
	107	+ if ($normalizedPath !== $path) {
	108	+ $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
	109	+ }
	110	+ }
111	111
112		- protected function scanFiles($user, $path, $verbose, OutputInterface $output, $backgroundScan = false) {
113		- $connection = $this->reconnectToDatabase($output);
114		- $scanner = new \OC\Files\Utils\Scanner($user, $connection, \OC::$server->getLogger());
115		- # check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
116		- # printout and count
117		- if ($verbose) {
118		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
119		- $output->writeln("\tFile <info>$path</info>");
120		- $this->filesCounter += 1;
121		- if ($this->hasBeenInterrupted()) {
122		- throw new InterruptedException();
123		- }
124		- });
125		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
126		- $output->writeln("\tFolder <info>$path</info>");
127		- $this->foldersCounter += 1;
128		- if ($this->hasBeenInterrupted()) {
129		- throw new InterruptedException();
130		- }
131		- });
132		- $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
133		- $output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
134		- });
135		- # count only
136		- } else {
137		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
138		- $this->filesCounter += 1;
139		- if ($this->hasBeenInterrupted()) {
140		- throw new InterruptedException();
141		- }
142		- });
143		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
144		- $this->foldersCounter += 1;
145		- if ($this->hasBeenInterrupted()) {
146		- throw new InterruptedException();
147		- }
148		- });
149		- }
150		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
151		- $this->checkScanWarning($path, $output);
152		- });
153		- $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
154		- $this->checkScanWarning($path, $output);
155		- });
	112	+ protected function scanFiles($user, $path, $verbose, OutputInterface $output, $backgroundScan = false) {
	113	+ $connection = $this->reconnectToDatabase($output);
	114	+ $scanner = new \OC\Files\Utils\Scanner($user, $connection, \OC::$server->getLogger());
	115	+ # check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
	116	+ # printout and count
	117	+ if ($verbose) {
	118	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
	119	+ $output->writeln("\tFile <info>$path</info>");
	120	+ $this->filesCounter += 1;
	121	+ if ($this->hasBeenInterrupted()) {
	122	+ throw new InterruptedException();
	123	+ }
	124	+ });
	125	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
	126	+ $output->writeln("\tFolder <info>$path</info>");
	127	+ $this->foldersCounter += 1;
	128	+ if ($this->hasBeenInterrupted()) {
	129	+ throw new InterruptedException();
	130	+ }
	131	+ });
	132	+ $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
	133	+ $output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
	134	+ });
	135	+ # count only
	136	+ } else {
	137	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
	138	+ $this->filesCounter += 1;
	139	+ if ($this->hasBeenInterrupted()) {
	140	+ throw new InterruptedException();
	141	+ }
	142	+ });
	143	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
	144	+ $this->foldersCounter += 1;
	145	+ if ($this->hasBeenInterrupted()) {
	146	+ throw new InterruptedException();
	147	+ }
	148	+ });
	149	+ }
	150	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
	151	+ $this->checkScanWarning($path, $output);
	152	+ });
	153	+ $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
	154	+ $this->checkScanWarning($path, $output);
	155	+ });
156	156
157		- try {
158		- if ($backgroundScan) {
159		- $scanner->backgroundScan($path);
160		- } else {
161		- $scanner->scan($path);
162		- }
163		- } catch (ForbiddenException $e) {
164		- $output->writeln("<error>Home storage for user $user not writable</error>");
165		- $output->writeln("Make sure you're running the scan command only as the user the web server runs as");
166		- } catch (InterruptedException $e) {
167		- # exit the function if ctrl-c has been pressed
168		- $output->writeln('Interrupted by user');
169		- } catch (NotFoundException $e) {
170		- $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
171		- } catch (\Exception $e) {
172		- $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
173		- $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
174		- }
175		- }
	157	+ try {
	158	+ if ($backgroundScan) {
	159	+ $scanner->backgroundScan($path);
	160	+ } else {
	161	+ $scanner->scan($path);
	162	+ }
	163	+ } catch (ForbiddenException $e) {
	164	+ $output->writeln("<error>Home storage for user $user not writable</error>");
	165	+ $output->writeln("Make sure you're running the scan command only as the user the web server runs as");
	166	+ } catch (InterruptedException $e) {
	167	+ # exit the function if ctrl-c has been pressed
	168	+ $output->writeln('Interrupted by user');
	169	+ } catch (NotFoundException $e) {
	170	+ $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
	171	+ } catch (\Exception $e) {
	172	+ $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
	173	+ $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
	174	+ }
	175	+ }
176	176
177	177
178		- protected function execute(InputInterface $input, OutputInterface $output) {
179		- $inputPath = $input->getOption('path');
180		- if ($inputPath) {
181		- $inputPath = '/' . trim($inputPath, '/');
182		- list (, $user,) = explode('/', $inputPath, 3);
183		- $users = array($user);
184		- } else if ($input->getOption('all')) {
185		- $users = $this->userManager->search('');
186		- } else {
187		- $users = $input->getArgument('user_id');
188		- }
	178	+ protected function execute(InputInterface $input, OutputInterface $output) {
	179	+ $inputPath = $input->getOption('path');
	180	+ if ($inputPath) {
	181	+ $inputPath = '/' . trim($inputPath, '/');
	182	+ list (, $user,) = explode('/', $inputPath, 3);
	183	+ $users = array($user);
	184	+ } else if ($input->getOption('all')) {
	185	+ $users = $this->userManager->search('');
	186	+ } else {
	187	+ $users = $input->getArgument('user_id');
	188	+ }
189	189
190		- # no messaging level option means: no full printout but statistics
191		- # $quiet means no print at all
192		- # $verbose means full printout including statistics
193		- # -q -v full stat
194		- # 0 0 no yes
195		- # 0 1 yes yes
196		- # 1 -- no no (quiet overrules verbose)
197		- $verbose = $input->getOption('verbose');
198		- $quiet = $input->getOption('quiet');
199		- # restrict the verbosity level to VERBOSITY_VERBOSE
200		- if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
201		- $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
202		- }
203		- if ($quiet) {
204		- $verbose = false;
205		- }
	190	+ # no messaging level option means: no full printout but statistics
	191	+ # $quiet means no print at all
	192	+ # $verbose means full printout including statistics
	193	+ # -q -v full stat
	194	+ # 0 0 no yes
	195	+ # 0 1 yes yes
	196	+ # 1 -- no no (quiet overrules verbose)
	197	+ $verbose = $input->getOption('verbose');
	198	+ $quiet = $input->getOption('quiet');
	199	+ # restrict the verbosity level to VERBOSITY_VERBOSE
	200	+ if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
	201	+ $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
	202	+ }
	203	+ if ($quiet) {
	204	+ $verbose = false;
	205	+ }
206	206
207		- # check quantity of users to be process and show it on the command line
208		- $users_total = count($users);
209		- if ($users_total === 0) {
210		- $output->writeln("<error>Please specify the user id to scan, \"--all\" to scan for all users or \"--path=...\"</error>");
211		- return;
212		- } else {
213		- if ($users_total > 1) {
214		- $output->writeln("\nScanning files for $users_total users");
215		- }
216		- }
	207	+ # check quantity of users to be process and show it on the command line
	208	+ $users_total = count($users);
	209	+ if ($users_total === 0) {
	210	+ $output->writeln("<error>Please specify the user id to scan, \"--all\" to scan for all users or \"--path=...\"</error>");
	211	+ return;
	212	+ } else {
	213	+ if ($users_total > 1) {
	214	+ $output->writeln("\nScanning files for $users_total users");
	215	+ }
	216	+ }
217	217
218		- $this->initTools();
	218	+ $this->initTools();
219	219
220		- $user_count = 0;
221		- foreach ($users as $user) {
222		- if (is_object($user)) {
223		- $user = $user->getUID();
224		- }
225		- $path = $inputPath ? $inputPath : '/' . $user;
226		- $user_count += 1;
227		- if ($this->userManager->userExists($user)) {
228		- # add an extra line when verbose is set to optical separate users
229		- if ($verbose) {
230		- $output->writeln("");
231		- }
232		- $output->writeln("Starting scan for user $user_count out of $users_total ($user)");
233		- # full: printout data if $verbose was set
234		- $this->scanFiles($user, $path, $verbose, $output, $input->getOption('unscanned'));
235		- } else {
236		- $output->writeln("<error>Unknown user $user_count $user</error>");
237		- }
238		- # check on each user if there was a user interrupt (ctrl-c) and exit foreach
239		- if ($this->hasBeenInterrupted()) {
240		- break;
241		- }
242		- }
	220	+ $user_count = 0;
	221	+ foreach ($users as $user) {
	222	+ if (is_object($user)) {
	223	+ $user = $user->getUID();
	224	+ }
	225	+ $path = $inputPath ? $inputPath : '/' . $user;
	226	+ $user_count += 1;
	227	+ if ($this->userManager->userExists($user)) {
	228	+ # add an extra line when verbose is set to optical separate users
	229	+ if ($verbose) {
	230	+ $output->writeln("");
	231	+ }
	232	+ $output->writeln("Starting scan for user $user_count out of $users_total ($user)");
	233	+ # full: printout data if $verbose was set
	234	+ $this->scanFiles($user, $path, $verbose, $output, $input->getOption('unscanned'));
	235	+ } else {
	236	+ $output->writeln("<error>Unknown user $user_count $user</error>");
	237	+ }
	238	+ # check on each user if there was a user interrupt (ctrl-c) and exit foreach
	239	+ if ($this->hasBeenInterrupted()) {
	240	+ break;
	241	+ }
	242	+ }
243	243
244		- # stat: printout statistics if $quiet was not set
245		- if (!$quiet) {
246		- $this->presentStats($output);
247		- }
248		- }
	244	+ # stat: printout statistics if $quiet was not set
	245	+ if (!$quiet) {
	246	+ $this->presentStats($output);
	247	+ }
	248	+ }
249	249
250		- /**
251		- * Initialises some useful tools for the Command
252		- */
253		- protected function initTools() {
254		- // Start the timer
255		- $this->execTime = -microtime(true);
256		- // Convert PHP errors to exceptions
257		- set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
258		- }
	250	+ /**
	251	+ * Initialises some useful tools for the Command
	252	+ */
	253	+ protected function initTools() {
	254	+ // Start the timer
	255	+ $this->execTime = -microtime(true);
	256	+ // Convert PHP errors to exceptions
	257	+ set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
	258	+ }
259	259
260		- /**
261		- * Processes PHP errors as exceptions in order to be able to keep track of problems
262		- *
263		- * @see https://secure.php.net/manual/en/function.set-error-handler.php
264		- *
265		- * @param int $severity the level of the error raised
266		- * @param string $message
267		- * @param string $file the filename that the error was raised in
268		- * @param int $line the line number the error was raised
269		- *
270		- * @throws \ErrorException
271		- */
272		- public function exceptionErrorHandler($severity, $message, $file, $line) {
273		- if (!(error_reporting() & $severity)) {
274		- // This error code is not included in error_reporting
275		- return;
276		- }
277		- throw new \ErrorException($message, 0, $severity, $file, $line);
278		- }
	260	+ /**
	261	+ * Processes PHP errors as exceptions in order to be able to keep track of problems
	262	+ *
	263	+ * @see https://secure.php.net/manual/en/function.set-error-handler.php
	264	+ *
	265	+ * @param int $severity the level of the error raised
	266	+ * @param string $message
	267	+ * @param string $file the filename that the error was raised in
	268	+ * @param int $line the line number the error was raised
	269	+ *
	270	+ * @throws \ErrorException
	271	+ */
	272	+ public function exceptionErrorHandler($severity, $message, $file, $line) {
	273	+ if (!(error_reporting() & $severity)) {
	274	+ // This error code is not included in error_reporting
	275	+ return;
	276	+ }
	277	+ throw new \ErrorException($message, 0, $severity, $file, $line);
	278	+ }
279	279
280		- /**
281		- * @param OutputInterface $output
282		- */
283		- protected function presentStats(OutputInterface $output) {
284		- // Stop the timer
285		- $this->execTime += microtime(true);
286		- $output->writeln("");
	280	+ /**
	281	+ * @param OutputInterface $output
	282	+ */
	283	+ protected function presentStats(OutputInterface $output) {
	284	+ // Stop the timer
	285	+ $this->execTime += microtime(true);
	286	+ $output->writeln("");
287	287
288		- $headers = [
289		- 'Folders', 'Files', 'Elapsed time'
290		- ];
	288	+ $headers = [
	289	+ 'Folders', 'Files', 'Elapsed time'
	290	+ ];
291	291
292		- $this->showSummary($headers, null, $output);
293		- }
	292	+ $this->showSummary($headers, null, $output);
	293	+ }
294	294
295		- /**
296		- * Shows a summary of operations
297		- *
298		- * @param string[] $headers
299		- * @param string[] $rows
300		- * @param OutputInterface $output
301		- */
302		- protected function showSummary($headers, $rows, OutputInterface $output) {
303		- $niceDate = $this->formatExecTime();
304		- if (!$rows) {
305		- $rows = [
306		- $this->foldersCounter,
307		- $this->filesCounter,
308		- $niceDate,
309		- ];
310		- }
311		- $table = new Table($output);
312		- $table
313		- ->setHeaders($headers)
314		- ->setRows([$rows]);
315		- $table->render();
316		- }
	295	+ /**
	296	+ * Shows a summary of operations
	297	+ *
	298	+ * @param string[] $headers
	299	+ * @param string[] $rows
	300	+ * @param OutputInterface $output
	301	+ */
	302	+ protected function showSummary($headers, $rows, OutputInterface $output) {
	303	+ $niceDate = $this->formatExecTime();
	304	+ if (!$rows) {
	305	+ $rows = [
	306	+ $this->foldersCounter,
	307	+ $this->filesCounter,
	308	+ $niceDate,
	309	+ ];
	310	+ }
	311	+ $table = new Table($output);
	312	+ $table
	313	+ ->setHeaders($headers)
	314	+ ->setRows([$rows]);
	315	+ $table->render();
	316	+ }
317	317
318	318
319		- /**
320		- * Formats microtime into a human readable format
321		- *
322		- * @return string
323		- */
324		- protected function formatExecTime() {
325		- list($secs, $tens) = explode('.', sprintf("%.1f", ($this->execTime)));
	319	+ /**
	320	+ * Formats microtime into a human readable format
	321	+ *
	322	+ * @return string
	323	+ */
	324	+ protected function formatExecTime() {
	325	+ list($secs, $tens) = explode('.', sprintf("%.1f", ($this->execTime)));
326	326
327		- # if you want to have microseconds add this: . '.' . $tens;
328		- return date('H:i:s', $secs);
329		- }
	327	+ # if you want to have microseconds add this: . '.' . $tens;
	328	+ return date('H:i:s', $secs);
	329	+ }
330	330
331		- /**
332		- * @return \OCP\IDBConnection
333		- */
334		- protected function reconnectToDatabase(OutputInterface $output) {
335		- /** @var Connection \| IDBConnection $connection */
336		- $connection = \OC::$server->getDatabaseConnection();
337		- try {
338		- $connection->close();
339		- } catch (\Exception $ex) {
340		- $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
341		- }
342		- while (!$connection->isConnected()) {
343		- try {
344		- $connection->connect();
345		- } catch (\Exception $ex) {
346		- $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
347		- sleep(60);
348		- }
349		- }
350		- return $connection;
351		- }
	331	+ /**
	332	+ * @return \OCP\IDBConnection
	333	+ */
	334	+ protected function reconnectToDatabase(OutputInterface $output) {
	335	+ /** @var Connection \| IDBConnection $connection */
	336	+ $connection = \OC::$server->getDatabaseConnection();
	337	+ try {
	338	+ $connection->close();
	339	+ } catch (\Exception $ex) {
	340	+ $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
	341	+ }
	342	+ while (!$connection->isConnected()) {
	343	+ try {
	344	+ $connection->connect();
	345	+ } catch (\Exception $ex) {
	346	+ $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
	347	+ sleep(60);
	348	+ }
	349	+ }
	350	+ return $connection;
	351	+ }
352	352
353	353	}

		@@ -47,199 +47,199 @@
		block discarded – undo
47	47	* @package OC\Files\Utils
48	48	*/
49	49	class Scanner extends PublicEmitter {
50		- /**
51		- * @var string $user
52		- */
53		- private $user;
54		-
55		- /**
56		- * @var \OCP\IDBConnection
57		- */
58		- protected $db;
59		-
60		- /**
61		- * @var ILogger
62		- */
63		- protected $logger;
64		-
65		- /**
66		- * @param string $user
67		- * @param \OCP\IDBConnection $db
68		- * @param ILogger $logger
69		- */
70		- public function __construct($user, $db, ILogger $logger) {
71		- $this->logger = $logger;
72		- $this->user = $user;
73		- $this->db = $db;
74		- }
75		-
76		- /**
77		- * get all storages for $dir
78		- *
79		- * @param string $dir
80		- * @return \OC\Files\Mount\MountPoint[]
81		- */
82		- protected function getMounts($dir) {
83		- //TODO: move to the node based fileapi once that's done
84		- \OC_Util::tearDownFS();
85		- \OC_Util::setupFS($this->user);
86		-
87		- $mountManager = Filesystem::getMountManager();
88		- $mounts = $mountManager->findIn($dir);
89		- $mounts[] = $mountManager->find($dir);
90		- $mounts = array_reverse($mounts); //start with the mount of $dir
91		-
92		- return $mounts;
93		- }
94		-
95		- /**
96		- * attach listeners to the scanner
97		- *
98		- * @param \OC\Files\Mount\MountPoint $mount
99		- */
100		- protected function attachListener($mount) {
101		- $scanner = $mount->getStorage()->getScanner();
102		- $emitter = $this;
103		- $scanner->listen('\OC\Files\Cache\Scanner', 'scanFile', function ($path) use ($mount, $emitter) {
104		- $emitter->emit('\OC\Files\Utils\Scanner', 'scanFile', array($mount->getMountPoint() . $path));
105		- });
106		- $scanner->listen('\OC\Files\Cache\Scanner', 'scanFolder', function ($path) use ($mount, $emitter) {
107		- $emitter->emit('\OC\Files\Utils\Scanner', 'scanFolder', array($mount->getMountPoint() . $path));
108		- });
109		- $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFile', function ($path) use ($mount, $emitter) {
110		- $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFile', array($mount->getMountPoint() . $path));
111		- });
112		- $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFolder', function ($path) use ($mount, $emitter) {
113		- $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFolder', array($mount->getMountPoint() . $path));
114		- });
115		- }
116		-
117		- /**
118		- * @param string $dir
119		- */
120		- public function backgroundScan($dir) {
121		- $mounts = $this->getMounts($dir);
122		- foreach ($mounts as $mount) {
123		- $storage = $mount->getStorage();
124		- if (is_null($storage)) {
125		- continue;
126		- }
127		-
128		- // don't bother scanning failed storages (shortcut for same result)
129		- if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
130		- continue;
131		- }
132		-
133		- // don't scan the root storage
134		- if ($storage->instanceOfStorage('\OC\Files\Storage\Local') && $mount->getMountPoint() === '/') {
135		- continue;
136		- }
137		-
138		- // don't scan received local shares, these can be scanned when scanning the owner's storage
139		- if ($storage->instanceOfStorage(SharedStorage::class)) {
140		- continue;
141		- }
142		- $scanner = $storage->getScanner();
143		- $this->attachListener($mount);
144		-
145		- $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
146		- $this->triggerPropagator($storage, $path);
147		- });
148		- $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
149		- $this->triggerPropagator($storage, $path);
150		- });
151		- $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
152		- $this->triggerPropagator($storage, $path);
153		- });
154		-
155		- $propagator = $storage->getPropagator();
156		- $propagator->beginBatch();
157		- $scanner->backgroundScan();
158		- $propagator->commitBatch();
159		- }
160		- }
161		-
162		- /**
163		- * @param string $dir
164		- * @throws \OC\ForbiddenException
165		- */
166		- public function scan($dir = '') {
167		- if (!Filesystem::isValidPath($dir)) {
168		- throw new \InvalidArgumentException('Invalid path to scan');
169		- }
170		- $mounts = $this->getMounts($dir);
171		- foreach ($mounts as $mount) {
172		- $storage = $mount->getStorage();
173		- if (is_null($storage)) {
174		- continue;
175		- }
176		-
177		- // don't bother scanning failed storages (shortcut for same result)
178		- if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
179		- continue;
180		- }
181		-
182		- // if the home storage isn't writable then the scanner is run as the wrong user
183		- if ($storage->instanceOfStorage('\OC\Files\Storage\Home') and
184		- (!$storage->isCreatable('') or !$storage->isCreatable('files'))
185		- ) {
186		- if ($storage->file_exists('') or $storage->getCache()->inCache('')) {
187		- throw new ForbiddenException();
188		- } else {// if the root exists in neither the cache nor the storage the user isn't setup yet
189		- break;
190		- }
191		-
192		- }
193		-
194		- // don't scan received local shares, these can be scanned when scanning the owner's storage
195		- if ($storage->instanceOfStorage(SharedStorage::class)) {
196		- continue;
197		- }
198		- $relativePath = $mount->getInternalPath($dir);
199		- $scanner = $storage->getScanner();
200		- $scanner->setUseTransactions(false);
201		- $this->attachListener($mount);
202		- $isDbLocking = \OC::$server->getLockingProvider() instanceof DBLockingProvider;
203		-
204		- $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
205		- $this->triggerPropagator($storage, $path);
206		- });
207		- $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
208		- $this->triggerPropagator($storage, $path);
209		- });
210		- $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
211		- $this->triggerPropagator($storage, $path);
212		- });
213		-
214		- if (!$isDbLocking) {
215		- $this->db->beginTransaction();
216		- }
217		- try {
218		- $propagator = $storage->getPropagator();
219		- $propagator->beginBatch();
220		- if (!$storage->file_exists($relativePath)) {
221		- throw new NotFoundException($dir);
222		- }
223		- $scanner->scan($relativePath, \OC\Files\Cache\Scanner::SCAN_RECURSIVE, \OC\Files\Cache\Scanner::REUSE_ETAG \| \OC\Files\Cache\Scanner::REUSE_SIZE);
224		- $cache = $storage->getCache();
225		- if ($cache instanceof Cache) {
226		- // only re-calculate for the root folder we scanned, anything below that is taken care of by the scanner
227		- $cache->correctFolderSize($relativePath);
228		- }
229		- $propagator->commitBatch();
230		- } catch (StorageNotAvailableException $e) {
231		- $this->logger->error('Storage ' . $storage->getId() . ' not available');
232		- $this->logger->logException($e);
233		- $this->emit('\OC\Files\Utils\Scanner', 'StorageNotAvailable', [$e]);
234		- }
235		- if (!$isDbLocking) {
236		- $this->db->commit();
237		- }
238		- }
239		- }
240		-
241		- private function triggerPropagator(IStorage $storage, $internalPath) {
242		- $storage->getPropagator()->propagateChange($internalPath, time());
243		- }
	50	+ /**
	51	+ * @var string $user
	52	+ */
	53	+ private $user;
	54	+
	55	+ /**
	56	+ * @var \OCP\IDBConnection
	57	+ */
	58	+ protected $db;
	59	+
	60	+ /**
	61	+ * @var ILogger
	62	+ */
	63	+ protected $logger;
	64	+
	65	+ /**
	66	+ * @param string $user
	67	+ * @param \OCP\IDBConnection $db
	68	+ * @param ILogger $logger
	69	+ */
	70	+ public function __construct($user, $db, ILogger $logger) {
	71	+ $this->logger = $logger;
	72	+ $this->user = $user;
	73	+ $this->db = $db;
	74	+ }
	75	+
	76	+ /**
	77	+ * get all storages for $dir
	78	+ *
	79	+ * @param string $dir
	80	+ * @return \OC\Files\Mount\MountPoint[]
	81	+ */
	82	+ protected function getMounts($dir) {
	83	+ //TODO: move to the node based fileapi once that's done
	84	+ \OC_Util::tearDownFS();
	85	+ \OC_Util::setupFS($this->user);
	86	+
	87	+ $mountManager = Filesystem::getMountManager();
	88	+ $mounts = $mountManager->findIn($dir);
	89	+ $mounts[] = $mountManager->find($dir);
	90	+ $mounts = array_reverse($mounts); //start with the mount of $dir
	91	+
	92	+ return $mounts;
	93	+ }
	94	+
	95	+ /**
	96	+ * attach listeners to the scanner
	97	+ *
	98	+ * @param \OC\Files\Mount\MountPoint $mount
	99	+ */
	100	+ protected function attachListener($mount) {
	101	+ $scanner = $mount->getStorage()->getScanner();
	102	+ $emitter = $this;
	103	+ $scanner->listen('\OC\Files\Cache\Scanner', 'scanFile', function ($path) use ($mount, $emitter) {
	104	+ $emitter->emit('\OC\Files\Utils\Scanner', 'scanFile', array($mount->getMountPoint() . $path));
	105	+ });
	106	+ $scanner->listen('\OC\Files\Cache\Scanner', 'scanFolder', function ($path) use ($mount, $emitter) {
	107	+ $emitter->emit('\OC\Files\Utils\Scanner', 'scanFolder', array($mount->getMountPoint() . $path));
	108	+ });
	109	+ $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFile', function ($path) use ($mount, $emitter) {
	110	+ $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFile', array($mount->getMountPoint() . $path));
	111	+ });
	112	+ $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFolder', function ($path) use ($mount, $emitter) {
	113	+ $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFolder', array($mount->getMountPoint() . $path));
	114	+ });
	115	+ }
	116	+
	117	+ /**
	118	+ * @param string $dir
	119	+ */
	120	+ public function backgroundScan($dir) {
	121	+ $mounts = $this->getMounts($dir);
	122	+ foreach ($mounts as $mount) {
	123	+ $storage = $mount->getStorage();
	124	+ if (is_null($storage)) {
	125	+ continue;
	126	+ }
	127	+
	128	+ // don't bother scanning failed storages (shortcut for same result)
	129	+ if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
	130	+ continue;
	131	+ }
	132	+
	133	+ // don't scan the root storage
	134	+ if ($storage->instanceOfStorage('\OC\Files\Storage\Local') && $mount->getMountPoint() === '/') {
	135	+ continue;
	136	+ }
	137	+
	138	+ // don't scan received local shares, these can be scanned when scanning the owner's storage
	139	+ if ($storage->instanceOfStorage(SharedStorage::class)) {
	140	+ continue;
	141	+ }
	142	+ $scanner = $storage->getScanner();
	143	+ $this->attachListener($mount);
	144	+
	145	+ $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
	146	+ $this->triggerPropagator($storage, $path);
	147	+ });
	148	+ $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
	149	+ $this->triggerPropagator($storage, $path);
	150	+ });
	151	+ $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
	152	+ $this->triggerPropagator($storage, $path);
	153	+ });
	154	+
	155	+ $propagator = $storage->getPropagator();
	156	+ $propagator->beginBatch();
	157	+ $scanner->backgroundScan();
	158	+ $propagator->commitBatch();
	159	+ }
	160	+ }
	161	+
	162	+ /**
	163	+ * @param string $dir
	164	+ * @throws \OC\ForbiddenException
	165	+ */
	166	+ public function scan($dir = '') {
	167	+ if (!Filesystem::isValidPath($dir)) {
	168	+ throw new \InvalidArgumentException('Invalid path to scan');
	169	+ }
	170	+ $mounts = $this->getMounts($dir);
	171	+ foreach ($mounts as $mount) {
	172	+ $storage = $mount->getStorage();
	173	+ if (is_null($storage)) {
	174	+ continue;
	175	+ }
	176	+
	177	+ // don't bother scanning failed storages (shortcut for same result)
	178	+ if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
	179	+ continue;
	180	+ }
	181	+
	182	+ // if the home storage isn't writable then the scanner is run as the wrong user
	183	+ if ($storage->instanceOfStorage('\OC\Files\Storage\Home') and
	184	+ (!$storage->isCreatable('') or !$storage->isCreatable('files'))
	185	+ ) {
	186	+ if ($storage->file_exists('') or $storage->getCache()->inCache('')) {
	187	+ throw new ForbiddenException();
	188	+ } else {// if the root exists in neither the cache nor the storage the user isn't setup yet
	189	+ break;
	190	+ }
	191	+
	192	+ }
	193	+
	194	+ // don't scan received local shares, these can be scanned when scanning the owner's storage
	195	+ if ($storage->instanceOfStorage(SharedStorage::class)) {
	196	+ continue;
	197	+ }
	198	+ $relativePath = $mount->getInternalPath($dir);
	199	+ $scanner = $storage->getScanner();
	200	+ $scanner->setUseTransactions(false);
	201	+ $this->attachListener($mount);
	202	+ $isDbLocking = \OC::$server->getLockingProvider() instanceof DBLockingProvider;
	203	+
	204	+ $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
	205	+ $this->triggerPropagator($storage, $path);
	206	+ });
	207	+ $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
	208	+ $this->triggerPropagator($storage, $path);
	209	+ });
	210	+ $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
	211	+ $this->triggerPropagator($storage, $path);
	212	+ });
	213	+
	214	+ if (!$isDbLocking) {
	215	+ $this->db->beginTransaction();
	216	+ }
	217	+ try {
	218	+ $propagator = $storage->getPropagator();
	219	+ $propagator->beginBatch();
	220	+ if (!$storage->file_exists($relativePath)) {
	221	+ throw new NotFoundException($dir);
	222	+ }
	223	+ $scanner->scan($relativePath, \OC\Files\Cache\Scanner::SCAN_RECURSIVE, \OC\Files\Cache\Scanner::REUSE_ETAG \| \OC\Files\Cache\Scanner::REUSE_SIZE);
	224	+ $cache = $storage->getCache();
	225	+ if ($cache instanceof Cache) {
	226	+ // only re-calculate for the root folder we scanned, anything below that is taken care of by the scanner
	227	+ $cache->correctFolderSize($relativePath);
	228	+ }
	229	+ $propagator->commitBatch();
	230	+ } catch (StorageNotAvailableException $e) {
	231	+ $this->logger->error('Storage ' . $storage->getId() . ' not available');
	232	+ $this->logger->logException($e);
	233	+ $this->emit('\OC\Files\Utils\Scanner', 'StorageNotAvailable', [$e]);
	234	+ }
	235	+ if (!$isDbLocking) {
	236	+ $this->db->commit();
	237	+ }
	238	+ }
	239	+ }
	240	+
	241	+ private function triggerPropagator(IStorage $storage, $internalPath) {
	242	+ $storage->getPropagator()->propagateChange($internalPath, time());
	243	+ }
244	244	}
245	245

nextcloud / server

Pull Request — master (#4396)

Status

Category

Indentation +281 added lines, -281 removed lines patch added patch discarded remove patch

Spacing +14 added lines, -14 removed lines patch added patch discarded remove patch

Indentation +194 added lines, -194 removed lines patch added patch discarded remove patch