1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\CoreAdminHome\Commands;
use Piwik\Archive\ArchivePurger;
use Piwik\DataAccess\ArchiveTableCreator;
use Piwik\Date;
use Piwik\Db;
use Piwik\Plugin\ConsoleCommand;
use Piwik\Timer;
use Piwik\Log\NullLogger;
/**
* Command that allows users to force purge old or invalid archive data. In the event of a failure
* in the archive purging scheduled task, this command can be used to manually delete old/invalid archives.
*/
class PurgeOldArchiveData extends ConsoleCommand
{
public const ALL_DATES_STRING = 'all';
/**
* For tests.
*
* @var Date
*/
public static $todayOverride = null;
/**
* @var ArchivePurger
*/
private $archivePurger;
public function __construct(?ArchivePurger $archivePurger = null)
{
parent::__construct();
$this->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. <comment>[" . $timer->__toString() . "]</comment>");
}
/**
* @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();
}
}
|
