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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\DataAccess;
use Exception;
use Piwik\Archive\ArchiveInvalidator;
use Piwik\ArchiveProcessor\ArchivingStatus;
use Piwik\ArchiveProcessor\Parameters;
use Piwik\ArchiveProcessor\Rules;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\Date;
use Piwik\Db;
use Piwik\DbHelper;
use Piwik\Period;
use Piwik\Segment;
use Piwik\Sequence;
use Piwik\SettingsServer;
use Piwik\Site;
use Psr\Log\LoggerInterface;
/**
* Cleans up outdated archives
*/
class Model
{
/**
* @var LoggerInterface
*/
private $logger;
/**
* @var ArchivingStatus
*/
private $archivingStatus;
public function __construct(LoggerInterface $logger = null)
{
$this->logger = $logger ?: StaticContainer::get('Psr\Log\LoggerInterface');
$this->archivingStatus = StaticContainer::get(ArchivingStatus::class);
}
/**
* Returns the archives IDs that have already been invalidated and have been since re-processed.
*
* These archives { archive name (includes segment hash) , idsite, date, period } will be deleted.
*
* @param string $archiveTable
* @param array $idSites
* @param bool $setGroupContentMaxLen for tests only
* @return array
* @throws Exception
*/
public function getInvalidatedArchiveIdsSafeToDelete($archiveTable, $setGroupContentMaxLen = true)
{
if ($setGroupContentMaxLen) {
try {
Db::get()->query('SET SESSION group_concat_max_len=' . (128 * 1024));
} catch (\Exception $ex) {
$this->logger->info("Could not set group_concat_max_len MySQL session variable.");
}
}
$sql = "SELECT idsite, date1, date2, period, name,
GROUP_CONCAT(idarchive, '.', value ORDER BY ts_archived DESC) as archives
FROM `$archiveTable`
WHERE name LIKE 'done%'
AND ts_archived IS NOT NULL
AND `value` NOT IN (" . ArchiveWriter::DONE_ERROR . ")
GROUP BY idsite, date1, date2, period, name HAVING count(*) > 1";
$archiveIds = array();
$rows = Db::fetchAll($sql);
foreach ($rows as $row) {
$duplicateArchives = explode(',', $row['archives']);
// do not consider purging partial archives, if they are the latest archive,
// and we don't want to delete the latest archive if it is usable
while (!empty($duplicateArchives)) {
$pair = $duplicateArchives[0];
if ($this->isCutOffGroupConcatResult($pair)) { // can occur if the GROUP_CONCAT value is cut off
break;
}
list($idarchive, $value) = explode('.', $pair);
array_shift($duplicateArchives);
if ($value != ArchiveWriter::DONE_PARTIAL) {
break;
}
}
// if there is more than one archive, the older invalidated ones can be deleted
if (!empty($duplicateArchives)) {
foreach ($duplicateArchives as $pair) {
if ($this->isCutOffGroupConcatResult($pair)) {
$this->logger->info("GROUP_CONCAT cut off the query result, you may have to purge archives again.");
break;
}
list($idarchive, $value) = explode('.', $pair);
$archiveIds[] = $idarchive; // does not matter what the value is, the latest is usable so older archives can be purged
}
}
}
return $archiveIds;
}
public function getPlaceholderArchiveIds($archiveTable)
{
$sql = "SELECT DISTINCT idarchive FROM `$archiveTable` WHERE ts_archived IS NULL";
$result = Db::fetchAll($sql);
$result = array_column($result, 'idarchive');
return $result;
}
public function updateArchiveAsInvalidated($archiveTable, $idSites, $allPeriodsToInvalidate, Segment $segment = null,
$forceInvalidateNonexistantRanges = false, $name = null)
{
if (empty($idSites)) {
return 0;
}
// select all idarchive/name pairs we want to invalidate
$sql = "SELECT idarchive, idsite, period, date1, date2, `name`, `value`
FROM `$archiveTable`
WHERE idsite IN (" . implode(',', $idSites) . ") AND value <> " . ArchiveWriter::DONE_PARTIAL;
$periodCondition = '';
if (!empty($allPeriodsToInvalidate)) {
$periodCondition .= " AND (";
$isFirst = true;
/** @var Period $period */
foreach ($allPeriodsToInvalidate as $period) {
if ($isFirst) {
$isFirst = false;
} else {
$periodCondition .= " OR ";
}
if ($period->getLabel() == 'range') { // for ranges, we delete all ranges that contain the given date(s)
$periodCondition .= "(period = " . (int)$period->getId()
. " AND date2 >= '" . $period->getDateStart()->getDatetime()
. "' AND date1 <= '" . $period->getDateEnd()->getDatetime() . "')";
} else {
$periodCondition .= "(period = " . (int)$period->getId()
. " AND date1 = '" . $period->getDateStart()->getDatetime() . "'"
. " AND date2 = '" . $period->getDateEnd()->getDatetime() . "')";
}
}
$periodCondition .= ")";
}
$sql .= $periodCondition;
if (!empty($name)) {
if (strpos($name, '.') !== false) {
list($plugin, $name) = explode('.', $name, 2);
} else {
$plugin = $name;
$name = null;
}
}
if (empty($plugin)) {
$doneFlag = Rules::getDoneFlagArchiveContainsAllPlugins($segment ?: new Segment('', []));
} else {
$doneFlag = Rules::getDoneFlagArchiveContainsOnePlugin($segment ?: new Segment('', []), $plugin);
}
$nameCondition = "name LIKE '$doneFlag%'";
$sql .= " AND $nameCondition";
$idArchives = [];
$archivesToInvalidate = [];
// update each archive as invalidated (but only for full archives or plugin archives, not for partial archives.
// DONE_INVALIDATED also implies that an archive is whole and not partial, and we want to avoid that.)
if (empty($name)) {
$archivesToInvalidate = Db::fetchAll($sql);
$idArchives = array_column($archivesToInvalidate, 'idarchive');
if (!empty($idArchives)) {
$idArchives = array_map('intval', $idArchives);
$sql = "UPDATE `$archiveTable` SET `value` = " . ArchiveWriter::DONE_INVALIDATED . " WHERE idarchive IN ("
. implode(',', $idArchives) . ") AND $nameCondition";
Db::query($sql);
}
}
// we add every archive we need to invalidate + the archives that do not already exist to archive_invalidations.
// except for archives that are DONE_IN_PROGRESS.
$archivesToCreateInvalidationRowsFor = [];
foreach ($archivesToInvalidate as $row) {
$archivesToCreateInvalidationRowsFor[$row['idsite']][$row['period']][$row['date1']][$row['date2']][$row['name']] = $row['idarchive'];
}
$now = Date::now()->getDatetime();
$existingInvalidations = $this->getExistingInvalidations($idSites, $periodCondition, $nameCondition);
$hashesOfAllSegmentsToArchiveInCoreArchive = Rules::getSegmentsToProcess($idSites);
$hashesOfAllSegmentsToArchiveInCoreArchive = array_map(function ($definition) use ($idSites) {
return (new Segment($definition, $idSites, Date::factory('yesterday'), Date::factory('today')))->getHash();
}, $hashesOfAllSegmentsToArchiveInCoreArchive);
$dummyArchives = [];
foreach ($idSites as $idSite) {
try {
$siteCreationTime = Site::getCreationDateFor($idSite);
} catch (\Exception $ex) {
continue;
}
$siteCreationTime = Date::factory($siteCreationTime);
foreach ($allPeriodsToInvalidate as $period) {
if ($period->getLabel() == 'range'
&& !$forceInvalidateNonexistantRanges
) {
continue; // range
}
if ($period->getDateEnd()->isEarlier($siteCreationTime)) {
continue; // don't add entries if it is before the time the site was created
}
$date1 = $period->getDateStart()->toString();
$date2 = $period->getDateEnd()->toString();
// we insert rows for the doneFlag we want to invalidate + any others we invalidated when doing the LIKE above.
// if we invalidated something in the archive tables, we want to make sure it appears in the invalidation queue,
// so we'll eventually reprocess it.
$doneFlagsFound = $archivesToCreateInvalidationRowsFor[$idSite][$period->getId()][$date1][$date2] ?? [];
$doneFlagsFound = array_keys($doneFlagsFound);
$doneFlagsToCheck = array_merge([$doneFlag], $doneFlagsFound);
$doneFlagsToCheck = array_unique($doneFlagsToCheck);
foreach ($doneFlagsToCheck as $doneFlagToCheck) {
$key = $this->makeExistingInvalidationArrayKey($idSite, $date1, $date2, $period->getId(), $doneFlagToCheck, $name);
if (!empty($existingInvalidations[$key])) {
continue; // avoid adding duplicates where possible
}
$hash = $this->getHashFromDoneFlag($doneFlagToCheck);
if ($doneFlagToCheck != $doneFlag
&& (empty($hash)
|| !in_array($hash, $hashesOfAllSegmentsToArchiveInCoreArchive)
|| strpos($doneFlagToCheck, '.') !== false)
) {
continue; // the done flag is for a segment that is not auto archive or a plugin specific archive, so we don't want to process it.
}
$idArchive = $archivesToCreateInvalidationRowsFor[$idSite][$period->getId()][$date1][$date2][$doneFlagToCheck] ?? null;
$dummyArchives[] = [
'idarchive' => $idArchive,
'name' => $doneFlagToCheck,
'report' => $name,
'idsite' => $idSite,
'date1' => $period->getDateStart()->getDatetime(),
'date2' => $period->getDateEnd()->getDatetime(),
'period' => $period->getId(),
'ts_invalidated' => $now,
];
}
}
}
if (!empty($dummyArchives)) {
$fields = ['idarchive', 'name', 'report', 'idsite', 'date1', 'date2', 'period', 'ts_invalidated'];
Db\BatchInsert::tableInsertBatch(Common::prefixTable('archive_invalidations'), $fields, $dummyArchives);
}
return count($idArchives);
}
private function getExistingInvalidations($idSites, $periodCondition, $nameCondition)
{
$table = Common::prefixTable('archive_invalidations');
$idSites = array_map('intval', $idSites);
$sql = "SELECT idsite, date1, date2, period, name, report, COUNT(*) as `count` FROM `$table`
WHERE idsite IN (" . implode(',', $idSites) . ") AND status = " . ArchiveInvalidator::INVALIDATION_STATUS_QUEUED . "
$periodCondition AND $nameCondition
GROUP BY idsite, date1, date2, period, name";
$rows = Db::fetchAll($sql);
$invalidations = [];
foreach ($rows as $row) {
$key = $this->makeExistingInvalidationArrayKey($row['idsite'], $row['date1'], $row['date2'], $row['period'], $row['name'], $row['report']);
$invalidations[$key] = $row['count'];
}
return $invalidations;
}
private function makeExistingInvalidationArrayKey($idSite, $date1, $date2, $period, $name, $report)
{
return implode('.', [$idSite, $date1, $date2, $period, $name, $report]);
}
/**
* @param string $archiveTable Prefixed table name
* @param int[] $idSites
* @param string[][] $datesByPeriodType
* @param Segment $segment
* @return \Zend_Db_Statement
* @throws Exception
*/
public function updateRangeArchiveAsInvalidated($archiveTable, $idSites, $allPeriodsToInvalidate, Segment $segment = null)
{
if (empty($idSites)) {
return;
}
$bind = array();
$periodConditions = array();
if (!empty($allPeriodsToInvalidate)) {
foreach ($allPeriodsToInvalidate as $period) {
$dateConditions = array();
/** @var Period $period */
$dateConditions[] = "(date1 <= ? AND ? <= date2)";
$bind[] = $period->getDateStart();
$bind[] = $period->getDateEnd();
$dateConditionsSql = implode(" OR ", $dateConditions);
$periodConditions[] = "(period = 5 AND ($dateConditionsSql))";
}
}
if ($segment) {
$nameCondition = "name LIKE '" . Rules::getDoneFlagArchiveContainsAllPlugins($segment) . "%'";
} else {
$nameCondition = "name LIKE 'done%'";
}
$sql = "UPDATE $archiveTable SET value = " . ArchiveWriter::DONE_INVALIDATED
. " WHERE $nameCondition
AND idsite IN (" . implode(", ", $idSites) . ")
AND (" . implode(" OR ", $periodConditions) . ")";
return Db::query($sql, $bind);
}
public function getTemporaryArchivesOlderThan($archiveTable, $purgeArchivesOlderThan)
{
$query = "SELECT idarchive FROM " . $archiveTable . "
WHERE name LIKE 'done%'
AND (( value = " . ArchiveWriter::DONE_OK_TEMPORARY . "
AND ts_archived < ?)
OR value = " . ArchiveWriter::DONE_ERROR . ")";
return Db::fetchAll($query, array($purgeArchivesOlderThan));
}
public function deleteArchivesWithPeriod($numericTable, $blobTable, $period, $date)
{
if (SettingsServer::isArchivePhpTriggered()) {
StaticContainer::get(LoggerInterface::class)->info('deleteArchivesWithPeriod: ' . $numericTable . ' with period = ' . $period . ' and date = ' . $date);
}
$query = "DELETE FROM %s WHERE period = ? AND ts_archived < ?";
$bind = array($period, $date);
$queryObj = Db::query(sprintf($query, $numericTable), $bind);
$deletedRows = $queryObj->rowCount();
try {
$queryObj = Db::query(sprintf($query, $blobTable), $bind);
$deletedRows += $queryObj->rowCount();
} catch (Exception $e) {
// Individual blob tables could be missing
$this->logger->debug("Unable to delete archives by period from {blobTable}.", array(
'blobTable' => $blobTable,
'exception' => $e,
));
}
return $deletedRows;
}
public function deleteArchiveIds($numericTable, $blobTable, $idsToDelete)
{
$idsToDelete = array_values($idsToDelete);
$idsToDelete = array_map('intval', $idsToDelete);
$query = "DELETE FROM %s WHERE idarchive IN (" . implode(',', $idsToDelete) . ")";
$queryObj = Db::query(sprintf($query, $numericTable), array());
$deletedRows = $queryObj->rowCount();
try {
$queryObj = Db::query(sprintf($query, $blobTable), array());
$deletedRows += $queryObj->rowCount();
} catch (Exception $e) {
// Individual blob tables could be missing
$this->logger->debug("Unable to delete archive IDs from {blobTable}.", array(
'blobTable' => $blobTable,
'exception' => $e,
));
}
return $deletedRows;
}
public function deleteOlderArchives(Parameters $params, $name, $tsArchived, $idArchive)
{
$dateStart = $params->getPeriod()->getDateStart();
$dateEnd = $params->getPeriod()->getDateEnd();
$numericTable = ArchiveTableCreator::getNumericTable($dateStart);
$blobTable = ArchiveTableCreator::getBlobTable($dateStart);
$sql = "SELECT idarchive FROM `$numericTable` WHERE idsite = ? AND date1 = ? AND date2 = ? AND period = ? AND name = ? AND ts_archived < ? AND idarchive < ?";
$idArchives = Db::fetchAll($sql, [$params->getSite()->getId(), $dateStart->getDatetime(), $dateEnd->getDatetime(), $params->getPeriod()->getId(), $name, $tsArchived, $idArchive]);
$idArchives = array_column($idArchives, 'idarchive');
if (empty($idArchives)) {
return;
}
if (SettingsServer::isArchivePhpTriggered()) {
StaticContainer::get(LoggerInterface::class)->info('deleteOlderArchives with ' . $params . ', name = ' . $name . ', ts_archived < ' . $tsArchived . ', idarchive < ' . $idArchive);
}
$this->deleteArchiveIds($numericTable, $blobTable, $idArchives);
}
public function getArchiveIdAndVisits($numericTable, $idSite, $period, $dateStartIso, $dateEndIso, $minDatetimeIsoArchiveProcessedUTC,
$doneFlags, $doneFlagValues = null)
{
$bindSQL = array($idSite,
$dateStartIso,
$dateEndIso,
$period,
);
$sqlWhereArchiveName = self::getNameCondition($doneFlags, $doneFlagValues);
$timeStampWhere = '';
if ($minDatetimeIsoArchiveProcessedUTC) {
$timeStampWhere = " AND arc1.ts_archived >= ? ";
$bindSQL[] = $minDatetimeIsoArchiveProcessedUTC;
}
// NOTE: we can't predict how many segments there will be so there could be lots of nb_visits/nb_visits_converted rows... have to select everything.
$sqlQuery = "SELECT arc1.idarchive, arc1.value, arc1.name, arc1.ts_archived, arc1.date1 as startDate, arc2.value as " . ArchiveSelector::NB_VISITS_RECORD_LOOKED_UP . ", arc3.value as " . ArchiveSelector::NB_VISITS_CONVERTED_RECORD_LOOKED_UP . "
FROM $numericTable arc1
LEFT JOIN $numericTable arc2 on arc2.idarchive = arc1.idarchive and (arc2.name = '" . ArchiveSelector::NB_VISITS_RECORD_LOOKED_UP . "')
LEFT JOIN $numericTable arc3 on arc3.idarchive = arc1.idarchive and (arc3.name = '" . ArchiveSelector::NB_VISITS_CONVERTED_RECORD_LOOKED_UP . "')
WHERE arc1.idsite = ?
AND arc1.date1 = ?
AND arc1.date2 = ?
AND arc1.period = ?
AND ($sqlWhereArchiveName)
$timeStampWhere
AND arc1.ts_archived IS NOT NULL
ORDER BY arc1.ts_archived DESC, arc1.idarchive DESC";
$results = Db::fetchAll($sqlQuery, $bindSQL);
return $results;
}
public function createArchiveTable($tableName, $tableNamePrefix)
{
$db = Db::get();
$sql = DbHelper::getTableCreateSql($tableNamePrefix);
// replace table name template by real name
$tableNamePrefix = Common::prefixTable($tableNamePrefix);
$sql = str_replace($tableNamePrefix, $tableName, $sql);
try {
$db->query($sql);
} catch (Exception $e) {
// accept mysql error 1050: table already exists, throw otherwise
if (!$db->isErrNo($e, '1050')) {
throw $e;
}
}
try {
if (ArchiveTableCreator::NUMERIC_TABLE === ArchiveTableCreator::getTypeFromTableName($tableName)) {
$sequence = new Sequence($tableName);
$sequence->create();
}
} catch (Exception $e) {
}
}
public function getInstalledArchiveTables()
{
$allArchiveNumeric = Db::get()->fetchCol("SHOW TABLES LIKE '" . Common::prefixTable('archive_numeric%') . "'");
$allArchiveBlob = Db::get()->fetchCol("SHOW TABLES LIKE '" . Common::prefixTable('archive_blob%') ."'");
return array_merge($allArchiveBlob, $allArchiveNumeric);
}
public function allocateNewArchiveId($numericTable)
{
$sequence = new Sequence($numericTable);
try {
$idarchive = $sequence->getNextId();
} catch (Exception $e) {
// edge case: sequence was not found, create it now
$sequence->create();
$idarchive = $sequence->getNextId();
}
return $idarchive;
}
public function updateArchiveStatus($numericTable, $archiveId, $doneFlag, $value)
{
Db::query("UPDATE $numericTable SET `value` = ? WHERE idarchive = ? and `name` = ?",
array($value, $archiveId, $doneFlag)
);
}
public function insertRecord($tableName, $fields, $record, $name, $value)
{
// duplicate idarchives are Ignored, see https://github.com/piwik/piwik/issues/987
$query = "INSERT IGNORE INTO " . $tableName . " (" . implode(", ", $fields) . ")
VALUES (?,?,?,?,?,?,?,?) ON DUPLICATE KEY UPDATE " . end($fields) . " = ?";
$bindSql = $record;
$bindSql[] = $name;
$bindSql[] = $value;
$bindSql[] = $value;
Db::query($query, $bindSql);
return true;
}
/**
* Returns the site IDs for invalidated archives in an archive table.
*
* @param string $numericTable The numeric table to search through.
* @return int[]
*/
public function getSitesWithInvalidatedArchive($numericTable)
{
$rows = Db::fetchAll("SELECT DISTINCT idsite FROM `$numericTable` WHERE `name` LIKE 'done%' AND `value` IN ("
. ArchiveWriter::DONE_INVALIDATED . ")");
$result = array();
foreach ($rows as $row) {
$result[] = $row['idsite'];
}
return $result;
}
/**
* Get a list of IDs of archives that don't have any matching rows in the site table. Excludes temporary archives
* that may still be in use, as specified by the $oldestToKeep passed in.
* @param string $archiveTableName
* @param string $oldestToKeep Datetime string
* @return array of IDs
*/
public function getArchiveIdsForDeletedSites($archiveTableName)
{
$sql = "SELECT DISTINCT idsite FROM " . $archiveTableName;
$rows = Db::getReader()->fetchAll($sql, array());
if (empty($rows)) {
return array(); // nothing to delete
}
$idSitesUsed = array_column($rows, 'idsite');
$model = new \Piwik\Plugins\SitesManager\Model();
$idSitesExisting = $model->getSitesId();
$deletedSites = array_diff($idSitesUsed, $idSitesExisting);
if (empty($deletedSites)) {
return array();
}
$deletedSites = array_values($deletedSites);
$deletedSites = array_map('intval', $deletedSites);
$sql = "SELECT DISTINCT idarchive FROM " . $archiveTableName . " WHERE idsite IN (".implode(',',$deletedSites).")";
$rows = Db::getReader()->fetchAll($sql, array());
return array_column($rows, 'idarchive');
}
/**
* Get a list of IDs of archives with segments that no longer exist in the DB. Excludes temporary archives that
* may still be in use, as specified by the $oldestToKeep passed in.
* @param string $archiveTableName
* @param array $segments List of segments to match against
* @param string $oldestToKeep Datetime string
* @return array With keys idarchive, name, idsite
*/
public function getArchiveIdsForSegments($archiveTableName, array $segments, $oldestToKeep)
{
$segmentClauses = [];
foreach ($segments as $segment) {
if (!empty($segment['definition'])) {
$segmentClauses[] = $this->getDeletedSegmentWhereClause($segment);
}
}
if (empty($segmentClauses)) {
return array();
}
$segmentClauses = implode(' OR ', $segmentClauses);
$sql = 'SELECT idarchive FROM ' . $archiveTableName
. ' WHERE ts_archived < ?'
. ' AND (' . $segmentClauses . ')';
$rows = Db::fetchAll($sql, array($oldestToKeep));
return array_column($rows, 'idarchive');
}
private function getDeletedSegmentWhereClause(array $segment)
{
$idSite = (int)$segment['enable_only_idsite'];
$segmentHash = $segment['hash'];
// Valid segment hashes are md5 strings - just confirm that it is so it's safe for SQL injection
if (!ctype_xdigit($segmentHash)) {
throw new Exception($segment . ' expected to be an md5 hash');
}
$nameClause = 'name LIKE "done' . $segmentHash . '%"';
$idSiteClause = '';
if ($idSite > 0) {
$idSiteClause = ' AND idsite = ' . $idSite;
} elseif (! empty($segment['idsites_to_preserve'])) {
// A segment for all sites was deleted, but there are segments for a single site with the same definition
$idSitesToPreserve = array_map('intval', $segment['idsites_to_preserve']);
$idSiteClause = ' AND idsite NOT IN (' . implode(',', $idSitesToPreserve) . ')';
}
return "($nameClause $idSiteClause)";
}
/**
* Returns the SQL condition used to find successfully completed archives that
* this instance is querying for.
*/
private static function getNameCondition($doneFlags, $possibleValues)
{
$allDoneFlags = "'" . implode("','", $doneFlags) . "'";
// create the SQL to find archives that are DONE
$result = "((arc1.name IN ($allDoneFlags))";
if (!empty($possibleValues)) {
$result .= " AND (arc1.value IN (" . implode(',', $possibleValues) . ")))";
}
$result .= ')';
return $result;
}
/**
* Marks an archive as in progress if it has not been already. This method must be thread
* safe.
*/
public function startArchive($invalidation)
{
$table = Common::prefixTable('archive_invalidations');
// set archive value to in progress if not set already
$statement = Db::query("UPDATE `$table` SET `status` = ?, ts_started = NOW() WHERE idinvalidation = ? AND status = ?", [
ArchiveInvalidator::INVALIDATION_STATUS_IN_PROGRESS,
$invalidation['idinvalidation'],
ArchiveInvalidator::INVALIDATION_STATUS_QUEUED,
]);
if ($statement->rowCount() > 0) { // if we updated, then we've marked the archive as started
return true;
}
// if we didn't get anything, some process either got there first, OR
// the archive was started previously and failed in a way that kept it's done value
// set to DONE_IN_PROGRESS. try to acquire the lock and if acquired, archiving isn' in process
// so we can claim it.
$lock = $this->archivingStatus->acquireArchiveInProgressLock($invalidation['idsite'], $invalidation['date1'],
$invalidation['date2'], $invalidation['period'], $invalidation['name']);
if (!$lock->isLocked()) {
return false; // we couldn't claim the lock, archive is in progress
}
// remove similar invalidations w/ lesser idinvalidation values
$bind = [
$invalidation['idsite'],
$invalidation['period'],
$invalidation['date1'],
$invalidation['date2'],
$invalidation['name'],
ArchiveInvalidator::INVALIDATION_STATUS_IN_PROGRESS,
];
if (empty($invalidation['report'])) {
$reportClause = "(report IS NULL OR report = '')";
} else {
$reportClause = "report = ?";
$bind[] = $invalidation['report'];
}
$sql = "DELETE FROM " . Common::prefixTable('archive_invalidations') . " WHERE idinvalidation < ? AND idsite = ? AND "
. "date1 = ? AND date2 = ? AND `period` = ? AND `name` = ? AND $reportClause";
Db::query($sql, $bind);
return true;
}
public function isSimilarArchiveInProgress($invalidation)
{
$table = Common::prefixTable('archive_invalidations');
$bind = [
$invalidation['idsite'],
$invalidation['period'],
$invalidation['date1'],
$invalidation['date2'],
$invalidation['name'],
ArchiveInvalidator::INVALIDATION_STATUS_IN_PROGRESS,
];
if (empty($invalidation['report'])) {
$reportClause = "(report IS NULL OR report = '')";
} else {
$reportClause = "report = ?";
$bind[] = $invalidation['report'];
}
$sql = "SELECT idinvalidation FROM `$table` WHERE idsite = ? AND `period` = ? AND date1 = ? AND date2 = ? AND `name` = ? AND `status` = ? AND ts_started IS NOT NULL AND $reportClause LIMIT 1";
$result = Db::fetchOne($sql, $bind);
return !empty($result);
}
/**
* Gets the next invalidated archive that should be archived in a table.
*
* @param int $idSite
* @param string $archivingStartTime
* @param int[]|null $idInvalidationsToExclude
* @param bool $useLimit Whether to limit the result set to one result or not. Used in tests only.
*/
public function getNextInvalidatedArchive($idSite, $archivingStartTime, $idInvalidationsToExclude = null, $useLimit = true)
{
$table = Common::prefixTable('archive_invalidations');
$sql = "SELECT idinvalidation, idarchive, idsite, date1, date2, period, `name`, report, ts_invalidated
FROM `$table`
WHERE idsite = ? AND status != ? AND ts_invalidated <= ?";
$bind = [
$idSite,
ArchiveInvalidator::INVALIDATION_STATUS_IN_PROGRESS,
$archivingStartTime,
];
if (!empty($idInvalidationsToExclude)) {
$idInvalidationsToExclude = array_map('intval', $idInvalidationsToExclude);
$sql .= " AND idinvalidation NOT IN (" . implode(',', $idInvalidationsToExclude) . ')';
}
// NOTE: order here is very important to ensure we process lower period archives first, and general 'all' archives before
// segment archives, and so we use the latest idinvalidation
$sql .= " ORDER BY date1 DESC, period ASC, CHAR_LENGTH(name) ASC, idinvalidation DESC";
if ($useLimit) {
$sql .= " LIMIT 1";
return Db::fetchRow($sql, $bind);
} else {
return Db::fetchAll($sql, $bind);
}
}
public function deleteInvalidations($archiveInvalidations)
{
$ids = array_column($archiveInvalidations, 'idinvalidation');
$ids = array_map('intval', $ids);
$table = Common::prefixTable('archive_invalidations');
$sql = "DELETE FROM `$table` WHERE idinvalidation IN (" . implode(', ', $ids) . ")";
Db::query($sql);
}
public function removeInvalidationsLike($idSite, $start)
{
$idSitesClause = $this->getRemoveInvalidationsIdSitesClause($idSite);
$table = Common::prefixTable('archive_invalidations');
$sql = "DELETE FROM `$table` WHERE $idSitesClause `name` LIKE ?";
Db::query($sql, ['done%.' . str_replace('_', "\\_", $start)]);
}
public function removeInvalidations($idSite, $plugin, $report)
{
$idSitesClause = $this->getRemoveInvalidationsIdSitesClause($idSite);
$table = Common::prefixTable('archive_invalidations');
$sql = "DELETE FROM `$table` WHERE $idSitesClause `name` LIKE ? AND report = ?";
Db::query($sql, ['done%.' . str_replace('_', "\\_", $plugin), $report]);
}
public function isArchiveAlreadyInProgress($invalidatedArchive)
{
$table = Common::prefixTable('archive_invalidations');
$bind = [
$invalidatedArchive['idsite'],
$invalidatedArchive['date1'],
$invalidatedArchive['date2'],
$invalidatedArchive['period'],
$invalidatedArchive['name'],
];
$reportClause = "(report = '' OR report IS NULL)";
if (!empty($invalidatedArchive['report'])) {
$reportClause = "report = ?";
$bind[] = $invalidatedArchive['report'];
}
$sql = "SELECT MAX(idinvalidation) FROM `$table` WHERE idsite = ? AND date1 = ? AND date2 = ? AND `period` = ? AND `name` = ? AND status = 1 AND $reportClause";
$inProgressInvalidation = Db::fetchOne($sql, $bind);
return $inProgressInvalidation;
}
/**
* Returns true if there is an archive that exists that can be used when aggregating an archive for $period.
*
* @param $idSite
* @param Period $period
* @return bool
* @throws Exception
*/
public function hasChildArchivesInPeriod($idSite, Period $period)
{
$date = $period->getDateStart();
while ($date->isEarlier($period->getDateEnd()->addPeriod(1, 'month'))) {
$archiveTable = ArchiveTableCreator::getNumericTable($date);
// we look for any archive that can be used to compute this one. this includes invalidated archives, since it is possible
// under certain circumstances for them to exist, when archiving a higher period that includes them. the main example being
// the GoogleAnalyticsImporter which disallows the recomputation of invalidated archives for imported data, since that would
// essentially get rid of the imported data.
$usableDoneFlags = [ArchiveWriter::DONE_OK, ArchiveWriter::DONE_INVALIDATED, ArchiveWriter::DONE_PARTIAL, ArchiveWriter::DONE_OK_TEMPORARY];
$sql = "SELECT idarchive
FROM `$archiveTable`
WHERE idsite = ? AND date1 >= ? AND date2 <= ? AND period < ? AND `name` LIKE 'done%' AND `value` IN (" . implode(', ', $usableDoneFlags) . ")
LIMIT 1";
$bind = [$idSite, $period->getDateStart()->getDatetime(), $period->getDateEnd()->getDatetime(), $period->getId()];
$result = (bool) Db::fetchOne($sql, $bind);
if ($result) {
return true;
}
$date = $date->addPeriod(1, 'month'); // move to next archive table
}
return false;
}
/**
* Returns true if any invalidations exists for the given
* $idsite and $doneFlag (name column) for the $period.
*
* @param mixed $idSite
* @param Period $period
* @param mixed $doneFlag
* @param mixed $report
* @return bool
* @throws Exception
*/
public function hasInvalidationForPeriodAndName($idSite, Period $period, $doneFlag, $report = null)
{
$table = Common::prefixTable('archive_invalidations');
if (empty($report)) {
$sql = "SELECT idinvalidation FROM `$table` WHERE idsite = ? AND date1 = ? AND date2 = ? AND `period` = ? AND `name` = ? AND `report` IS NULL LIMIT 1";
} else {
$sql = "SELECT idinvalidation FROM `$table` WHERE idsite = ? AND date1 = ? AND date2 = ? AND `period` = ? AND `name` = ? AND `report` = ? LIMIT 1";
}
$bind = [
$idSite,
$period->getDateStart()->toString(),
$period->getDateEnd()->toString(),
$period->getId(),
$doneFlag
];
if (!empty($report)) {
$bind[] = $report;
}
$idInvalidation = Db::fetchOne($sql, $bind);
if (empty($idInvalidation)) {
return false;
}
return true;
}
public function deleteInvalidationsForSites(array $idSites)
{
$idSites = array_map('intval', $idSites);
$table = Common::prefixTable('archive_invalidations');
$sql = "DELETE FROM `$table` WHERE idsite IN (" . implode(',', $idSites) . ")";
Db::query($sql);
}
public function deleteInvalidationsForDeletedSites()
{
$siteTable = Common::prefixTable('site');
$table = Common::prefixTable('archive_invalidations');
$sql = "DELETE a FROM `$table` a LEFT JOIN `$siteTable` s ON a.idsite = s.idsite WHERE s.idsite IS NULL";
Db::query($sql);
}
private function getRemoveInvalidationsIdSitesClause($idSite)
{
if ($idSite === 'all') {
return '';
}
$idSites = is_array($idSite) ? $idSite : [$idSite];
$idSites = array_map('intval', $idSites);
$idSitesStr = implode(',', $idSites);
return "idsite IN ($idSitesStr) AND";
}
public function releaseInProgressInvalidation($idinvalidation)
{
$table = Common::prefixTable('archive_invalidations');
$sql = "UPDATE $table SET status = " . ArchiveInvalidator::INVALIDATION_STATUS_QUEUED . ", ts_started = NULL WHERE idinvalidation = ?";
Db::query($sql, [$idinvalidation]);
}
public function resetFailedArchivingJobs()
{
$table = Common::prefixTable('archive_invalidations');
$sql = "UPDATE $table SET status = ? WHERE status = ? AND (ts_started IS NULL OR ts_started < ?)";
$bind = [
ArchiveInvalidator::INVALIDATION_STATUS_QUEUED,
ArchiveInvalidator::INVALIDATION_STATUS_IN_PROGRESS,
Date::now()->subDay(1)->getDatetime(),
];
$query = Db::query($sql, $bind);
return $query->rowCount();
}
private function isCutOffGroupConcatResult($pair)
{
$position = strpos($pair, '.');
return $position === false || $position === strlen($pair) - 1;
}
private function getHashFromDoneFlag($doneFlag)
{
preg_match('/^done([a-zA-Z0-9]+)/', $doneFlag, $matches);
return $matches[1] ?? '';
}
}
|