userManager->search('');
} else {
$users = $userIds;
}
# check quantity of users to be process and show it on the command line
$users_total = count($users);
if ($users_total === 0) {
$output->writeln('Please specify the user id to scan, --all to scan for all users or --path=...');
return ExitCode::Failure;
}
$this->initTools($output);
// null if --generate-metadata is not set, empty if option has no value, value if set
$metadata = match (true) {
$generateMetadata === false => null,
$generateMetadata === true => '',
default => $generateMetadata,
};
$scannedStorages = [];
$mountFilter = function (IMountPoint $mount) use ($homeOnly, &$scannedStorages) {
if ($homeOnly && !$this->isHomeMount($mount)) {
return false;
}
// when scanning multiple users, the scanner might encounter the same storage multiple times (e.g. external storages, or group folders)
// we can filter out any storage we've already scanned to avoid double work
$storage = $mount->getStorage();
$storageKey = $storage->getId();
while ($storage->instanceOfStorage(Jail::class)) {
$storageKey .= '/' . $storage->getUnjailedPath('');
$storage = $storage->getUnjailedStorage();
}
if (array_key_exists($storageKey, $scannedStorages)) {
return false;
}
$scannedStorages[$storageKey] = true;
return true;
};
$user_count = 0;
foreach ($users as $user) {
if (is_object($user)) {
$user = $user->getUID();
}
$scanPath = $inputPath ?: '/' . $user;
++$user_count;
if ($this->userManager->userExists($user)) {
$output->writeln("Starting scan for user $user_count out of $users_total ($user)");
$this->scanFiles(
$user,
$scanPath,
$metadata,
$output,
$signalHandler,
$mountFilter,
$unscanned,
!$shallow,
);
$output->writeln('', Verbosity::Verbose);
} else {
$output->writeln("Unknown user $user_count $user");
$output->writeln('', Verbosity::Verbose);
}
try {
$signalHandler->abortIfInterrupted();
} catch (InterruptedException) {
break;
}
}
$this->presentStats($output);
return ExitCode::Success;
}
protected function scanFiles(
string $user,
string $path,
?string $scanMetadata,
IOutput $output,
ISignalHandler $signalHandler,
callable $mountFilter,
bool $backgroundScan = false,
bool $recursive = true,
): void {
$connection = $this->reconnectToDatabase($output);
$scanner = new Scanner(
$this->userManager->get($user),
new ConnectionAdapter($connection),
$this->eventDispatcher,
$this->logger,
$this->setupManager,
);
# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function (string $path) use ($output, $signalHandler, $scanMetadata): void {
$output->writeln("\tFile\t$path", Verbosity::Verbose);
++$this->filesCounter;
$signalHandler->abortIfInterrupted();
if ($scanMetadata !== null) {
$node = $this->rootFolder->get($path);
$this->filesMetadataManager->refreshMetadata(
$node,
($scanMetadata !== '') ? IFilesMetadataManager::PROCESS_NAMED : IFilesMetadataManager::PROCESS_LIVE | IFilesMetadataManager::PROCESS_BACKGROUND,
$scanMetadata
);
}
});
$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output, $signalHandler): void {
$output->writeln("\tFolder\t$path", Verbosity::Verbose);
++$this->foldersCounter;
$signalHandler->abortIfInterrupted();
});
$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output): void {
$output->writeln('Error while scanning, storage not available (' . $e->getMessage() . ')', Verbosity::Verbose);
++$this->errorsCounter;
});
$scanner->listen('\OC\Files\Utils\Scanner', 'normalizedNameMismatch', function ($fullPath) use ($output): void {
$output->writeln("\tEntry \"" . $fullPath . '" will not be accessible due to incompatible encoding');
++$this->errorsCounter;
});
$this->eventDispatcher->addListener(NodeAddedToCache::class, function (): void {
++$this->newCounter;
});
$this->eventDispatcher->addListener(FileCacheUpdated::class, function (): void {
++$this->updatedCounter;
});
$this->eventDispatcher->addListener(NodeRemovedFromCache::class, function (): void {
++$this->removedCounter;
});
try {
if ($backgroundScan) {
$scanner->backgroundScan($path);
} else {
$scanner->scan($path, $recursive, $mountFilter);
}
} catch (ForbiddenException $e) {
$output->writeln("Home storage for user $user not writable or 'files' subdirectory missing");
$output->writeln(' ' . $e->getMessage());
$output->writeln('Make sure you\'re running the scan command only as the user the web server runs as');
++$this->errorsCounter;
} catch (InterruptedException) {
# exit the function if ctrl-c has been pressed
$output->writeln('Interrupted by user');
} catch (NotFoundException $e) {
$output->writeln('Path not found: ' . $e->getMessage() . '');
++$this->errorsCounter;
} catch (LockedException $e) {
if (str_starts_with($e->getPath(), 'scanner::')) {
$output->writeln('Another process is already scanning \'' . substr($e->getPath(), strlen('scanner::')) . '\'');
} else {
throw $e;
}
} catch (\Exception $e) {
$output->writeln('Exception during scan: ' . $e->getMessage() . '');
$output->writeln('' . $e->getTraceAsString() . '');
++$this->errorsCounter;
}
}
public function isHomeMount(IMountPoint $mountPoint): bool {
// any mountpoint inside '/$user/files/'
return substr_count($mountPoint->getMountPoint(), '/') <= 3;
}
/**
* Initialises some useful tools for the Command
*/
protected function initTools(IOutput $output): void {
// Start the timer
$this->execTime = -microtime(true);
// Convert PHP errors to exceptions
set_error_handler(
fn (int $severity, string $message, string $file, int $line): bool
=> $this->exceptionErrorHandler($output, $severity, $message, $file, $line),
E_ALL
);
}
/**
* Processes PHP errors in order to be able to show them in the output
*
* @see https://www.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
*/
public function exceptionErrorHandler(IOutput $output, int $severity, string $message, string $file, int $line): bool {
if (($severity === E_DEPRECATED) || ($severity === E_USER_DEPRECATED)) {
// Do not show deprecation warnings
return false;
}
$e = new \ErrorException($message, 0, $severity, $file, $line);
$output->writeln('Error during scan: ' . $e->getMessage() . '');
$output->writeln('' . $e->getTraceAsString() . '', Verbosity::VeryVerbose);
++$this->errorsCounter;
return true;
}
protected function presentStats(IOutput $output): void {
// Stop the timer
$this->execTime += microtime(true);
$this->logger->info("Completed scan of {$this->filesCounter} files in {$this->foldersCounter} folder. Found {$this->newCounter} new, {$this->updatedCounter} updated and {$this->removedCounter} removed items");
$row = [
'Folders' => $this->foldersCounter,
'Files' => $this->filesCounter,
'New' => $this->newCounter,
'Updated' => $this->updatedCounter,
'Removed' => $this->removedCounter,
'Errors' => $this->errorsCounter,
'Elapsed time' => $this->formatExecTime(),
];
$output->writeTableInOutputFormat([$row]);
}
/**
* Formats microtime into a human-readable format
*/
protected function formatExecTime(): string {
$secs = (int)round($this->execTime);
# convert seconds into HH:MM:SS form
return sprintf('%02d:%02d:%02d', (int)($secs / 3600), ((int)($secs / 60) % 60), $secs % 60);
}
protected function reconnectToDatabase(IOutput $output): Connection {
/** @var Connection $connection */
$connection = Server::get(Connection::class);
try {
$connection->close();
} catch (\Exception $ex) {
$output->writeln("Error while disconnecting from database: {$ex->getMessage()}");
}
while (!$connection->isConnected()) {
try {
$connection->connect();
} catch (\Exception $ex) {
$output->writeln("Error while re-connecting to database: {$ex->getMessage()}");
sleep(60);
}
}
return $connection;
}
}