Ubuntu
setName('diagnostics:unexpected-files')->setDescription('Show a list of unexpected files found in the Matomo installation directory and optionally delete them.')->addNoValueOption('delete', null, 'Delete all the unexpected files');
}
/**
* Execute the command
*
*/
protected function doExecute() : int
{
$input = $this->getInput();
$output = $this->getOutput();
// Prevent running in development mode
if (Development::isEnabled()) {
$output->writeln("Aborting - this command cannot be used in development mode as it requires a release manifest file");
return 1;
}
// Prevent running if there is no release manifest file
$manifest = PIWIK_INCLUDE_PATH . '/config/manifest.inc.php';
if (!file_exists($manifest)) {
$output->writeln("Release manifest file '" . $manifest . "' not found.");
$output->writeln("Aborting - this command can only be used when a release manifest file is present.");
return 1;
}
$delete = $input->getOption('delete');
if ($delete) {
$output->writeln("Preparing to delete all unexpected files from the Matomo installation directory");
if (!$this->askForDeleteConfirmation()) {
$output->writeln("Aborted - no files were deleted");
return 1;
}
return $this->runUnexpectedFiles(\true);
}
return $this->runUnexpectedFiles(\false);
}
/**
* Handle unexpected files command options
*
*
*/
private function runUnexpectedFiles(bool $delete = \false) : int
{
$output = $this->getOutput();
// A list of files that should never be deleted under any circumstances, this acts as a backup safety check
// for the FileIntegrity class which should already be excluding these files.
$excludedFiles = [
'/^config\\/config.ini.php$/',
// main config file
'/^config\\/common.config.ini.php$/',
// multi-tenant config file
'/\\.htaccess$/',
// apache directory access rules
'/^config\\/config.php$/',
// DI customisation
'/^misc\\/.*$/',
];
$files = FileIntegrity::getUnexpectedFilesList();
$fails = 0;
foreach ($files as $f) {
foreach ($excludedFiles as $ef) {
if (preg_match($ef, $f)) {
continue 2;
}
}
$fileName = realpath($f);
if ($delete) {
if (Filesystem::deleteFileIfExists($fileName)) {
$output->writeln("Deleted unexpected file '" . $fileName);
} else {
$output->writeln("Failed to delete unexpected file '" . $fileName);
$fails++;
}
} else {
$output->writeln($fileName);
}
}
if ($delete && $fails) {
$output->writeln("Failed to delete " . $fails . " unexpected files");
return 1;
}
return 0;
}
/**
* Interact with the user to confirm the deletion
*
*/
private function askForDeleteConfirmation() : bool
{
if (!$this->getInput()->isInteractive()) {
return \true;
}
return $this->askForConfirmation('You are about to delete files. This action cannot be undone, are you sure you want to continue? (Y/N)', \false);
}
}