Ubuntu
archivePurger = $archivePurger;
}
protected function configure()
{
$this->setName('core:purge-old-archive-data');
$this->setDescription('Purges out of date and invalid archive data from archive tables.');
$this->addOptionalArgument("dates", sprintf("The months of the archive tables to purge data from. By default, only deletes from the current month. Use '%s' for all dates.", self::ALL_DATES_STRING), [self::getToday()->toString()], \true);
$this->addNoValueOption('exclude-outdated', null, "Do not purge outdated archive data.");
$this->addNoValueOption('exclude-invalidated', null, "Do not purge invalidated archive data.");
$this->addNoValueOption('exclude-ranges', null, "Do not purge custom ranges.");
$this->addNoValueOption('skip-optimize-tables', null, "Do not run OPTIMIZE TABLES query on affected archive tables.");
$this->addNoValueOption('include-year-archives', null, "If supplied, the command will purge archive tables that contain year archives for every supplied date.");
$this->setHelp("By default old and invalidated archives are purged. Custom ranges are also purged with outdated archives.\n\n" . "Note: archive purging is done during scheduled task execution, so under normal circumstances, you should not need to " . "run this command manually.");
}
protected function doExecute() : int
{
$input = $this->getInput();
$output = $this->getOutput();
// during normal command execution, we don't want the INFO level logs logged by the ArchivePurger service
// to display in the console, so we use a NullLogger for the service
$logger = null;
if (!$output->isVerbose()) {
$logger = new NullLogger();
}
$archivePurger = $this->archivePurger ?: new ArchivePurger($model = null, $purgeDatesOlderThan = null, $logger);
$dates = $this->getDatesToPurgeFor();
$excludeOutdated = $input->getOption('exclude-outdated');
if ($excludeOutdated) {
$output->writeln("Skipping purge outdated archive data.");
} else {
foreach ($dates as $date) {
$message = sprintf("Purging outdated archives for %s...", $date->toString('Y_m'));
$this->performTimedPurging($message, function () use($date, $archivePurger) {
$archivePurger->purgeOutdatedArchives($date);
});
}
}
$excludeInvalidated = $input->getOption('exclude-invalidated');
if ($excludeInvalidated) {
$output->writeln("Skipping purge invalidated archive data.");
} else {
foreach ($dates as $date) {
$message = sprintf("Purging invalidated archives for %s...", $date->toString('Y_m'));
$this->performTimedPurging($message, function () use($archivePurger, $date) {
$archivePurger->purgeInvalidatedArchivesFrom($date);
});
}
}
$excludeCustomRanges = $input->getOption('exclude-ranges');
if ($excludeCustomRanges) {
$output->writeln("Skipping purge custom range archives.");
} else {
foreach ($dates as $date) {
$message = sprintf("Purging custom range archives for %s...", $date->toString('Y_m'));
$this->performTimedPurging($message, function () use($date, $archivePurger) {
$archivePurger->purgeArchivesWithPeriodRange($date);
});
}
}
$skipOptimizeTables = $input->getOption('skip-optimize-tables');
if ($skipOptimizeTables) {
$output->writeln("Skipping OPTIMIZE TABLES.");
} else {
$this->optimizeArchiveTables($dates);
}
return self::SUCCESS;
}
/**
* @return Date[]
*/
private function getDatesToPurgeFor()
{
$dates = array();
$dateSpecifier = $this->getInput()->getArgument('dates');
if (count($dateSpecifier) === 1 && reset($dateSpecifier) == self::ALL_DATES_STRING) {
foreach (ArchiveTableCreator::getTablesArchivesInstalled(ArchiveTableCreator::NUMERIC_TABLE) as $table) {
$tableDate = ArchiveTableCreator::getDateFromTableName($table);
list($year, $month) = explode('_', $tableDate);
try {
$date = Date::factory($year . '-' . $month . '-' . '01');
$dates[] = $date;
} catch (\Exception $e) {
// this might occur if archive tables like piwik_archive_numeric_1875_09 exist
}
}
} else {
$includeYearArchives = $this->getInput()->getOption('include-year-archives');
foreach ($dateSpecifier as $date) {
$dateObj = Date::factory($date);
$yearMonth = $dateObj->toString('Y-m');
$dates[$yearMonth] = $dateObj;
// if --include-year-archives is supplied, add a date for the january table for this date's year
// so year archives will be purged
if ($includeYearArchives) {
$janYearMonth = $dateObj->toString('Y') . '-01';
if (empty($dates[$janYearMonth])) {
$dates[$janYearMonth] = Date::factory($janYearMonth . '-01');
}
}
}
$dates = array_values($dates);
}
return array_unique($dates);
}
private function performTimedPurging($startMessage, $callback)
{
$timer = new Timer();
$this->getOutput()->write($startMessage);
$callback();
$this->getOutput()->writeln("Done. [" . $timer->__toString() . "]");
}
/**
* @param Date[] $dates
*/
private function optimizeArchiveTables($dates)
{
$this->getOutput()->writeln("Optimizing archive tables...");
foreach ($dates as $date) {
$numericTable = ArchiveTableCreator::getNumericTable($date);
$this->performTimedPurging("Optimizing table {$numericTable}...", function () use($numericTable) {
Db\Schema::getInstance()->optimizeTables([$numericTable], $force = \true);
});
$blobTable = ArchiveTableCreator::getBlobTable($date);
$this->performTimedPurging("Optimizing table {$blobTable}...", function () use($blobTable) {
Db\Schema::getInstance()->optimizeTables([$blobTable], $force = \true);
});
}
}
private static function getToday()
{
return self::$todayOverride ?: Date::today();
}
}