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
|
<?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\Goals\RecordBuilders;
use Piwik\ArchiveProcessor;
use Piwik\ArchiveProcessor\Record;
use Piwik\DataAccess\LogAggregator;
use Piwik\DataTable;
use Piwik\Metrics;
use Piwik\Plugin\Manager;
use Piwik\Plugins\Goals\API;
use Piwik\Plugins\Goals\Archiver;
use Piwik\Plugins\Goals\Goals;
use Piwik\Tracker\GoalManager;
class GeneralGoalsRecords extends Base
{
public const VISITS_COUNT_FIELD = 'visitor_count_visits';
public const LOG_CONVERSION_TABLE = 'log_conversion';
public const SECONDS_SINCE_FIRST_VISIT_FIELD = 'visitor_seconds_since_first';
protected function aggregate(ArchiveProcessor $archiveProcessor): array
{
$idSite = $this->getSiteId($archiveProcessor);
if (empty($idSite)) {
return [];
}
$prefixes = [
Archiver::VISITS_UNTIL_RECORD_NAME => 'vcv',
Archiver::DAYS_UNTIL_CONV_RECORD_NAME => 'vdsf',
];
$totalConversions = 0;
$totalRevenue = 0;
$goalMetrics = [];
$visitsToConversions = [];
$daysToConversions = [];
$siteHasEcommerceOrGoals = $this->hasAnyGoalOrEcommerce($idSite);
// Special handling for sites that contain subordinated sites, like in roll up reporting.
// A roll up site, might not have ecommerce enabled or any configured goals,
// but if a subordinated site has, we calculate the overview conversion metrics nevertheless
if ($siteHasEcommerceOrGoals === false) {
$idSitesToArchive = $archiveProcessor->getParams()->getIdSites();
foreach ($idSitesToArchive as $idSite) {
if ($this->hasAnyGoalOrEcommerce($idSite)) {
$siteHasEcommerceOrGoals = true;
break;
}
}
}
$logAggregator = $archiveProcessor->getLogAggregator();
// try to query goal data only, if goals or ecommerce is actually used
// otherwise we simply insert empty records
if ($siteHasEcommerceOrGoals) {
$selects = [];
$selects = array_merge($selects, LogAggregator::getSelectsFromRangedColumn(
self::VISITS_COUNT_FIELD,
Archiver::$visitCountRanges,
self::LOG_CONVERSION_TABLE,
$prefixes[Archiver::VISITS_UNTIL_RECORD_NAME]
));
$selects = array_merge($selects, LogAggregator::getSelectsFromRangedColumn(
'FLOOR(log_conversion.' . self::SECONDS_SINCE_FIRST_VISIT_FIELD . ' / 86400)',
Archiver::$daysToConvRanges,
self::LOG_CONVERSION_TABLE,
$prefixes[Archiver::DAYS_UNTIL_CONV_RECORD_NAME]
));
$query = $logAggregator->queryConversionsByDimension([], false, $selects);
if ($query === false) {
return [];
}
$conversionMetrics = $logAggregator->getConversionsMetricFields();
while ($row = $query->fetch()) {
$idGoal = $row['idgoal'];
unset($row['idgoal']);
unset($row['label']);
foreach ($conversionMetrics as $field => $statement) {
$goalMetrics[$idGoal][$field] = ($goalMetrics[$idGoal][$field] ?? 0) + $row[$field];
}
if (empty($visitsToConversions[$idGoal])) {
$visitsToConversions[$idGoal] = new DataTable();
}
$array = LogAggregator::makeArrayOneColumn($row, Metrics::INDEX_NB_CONVERSIONS, $prefixes[Archiver::VISITS_UNTIL_RECORD_NAME]);
$visitsToConversions[$idGoal]->addDataTable(DataTable::makeFromIndexedArray($array));
if (empty($daysToConversions[$idGoal])) {
$daysToConversions[$idGoal] = new DataTable();
}
$array = LogAggregator::makeArrayOneColumn($row, Metrics::INDEX_NB_CONVERSIONS, $prefixes[Archiver::DAYS_UNTIL_CONV_RECORD_NAME]);
$daysToConversions[$idGoal]->addDataTable(DataTable::makeFromIndexedArray($array));
// We don't want to sum Abandoned cart metrics in the overall revenue/conversions/converted visits
// since it is a "negative conversion"
if ($idGoal != GoalManager::IDGOAL_CART) {
$totalConversions += $row[Metrics::INDEX_GOAL_NB_CONVERSIONS];
$totalRevenue += $row[Metrics::INDEX_GOAL_REVENUE];
}
}
}
// Stats by goal, for all visitors
$numericRecords = $this->getConversionsNumericMetrics($goalMetrics);
$nbConvertedVisits = $archiveProcessor->getNumberOfVisitsConverted();
$result = array_merge([
// Stats for all goals
Archiver::getRecordName('nb_conversions') => $totalConversions,
Archiver::getRecordName('nb_visits_converted') => $nbConvertedVisits,
Archiver::getRecordName('revenue') => $totalRevenue,
], $numericRecords);
foreach ($visitsToConversions as $idGoal => $table) {
$recordName = Archiver::getRecordName(Archiver::VISITS_UNTIL_RECORD_NAME, $idGoal);
$result[$recordName] = $table;
}
$result[Archiver::getRecordName(Archiver::VISITS_UNTIL_RECORD_NAME)] = $this->getOverviewFromGoalTables($visitsToConversions);
foreach ($daysToConversions as $idGoal => $table) {
$recordName = Archiver::getRecordName(Archiver::DAYS_UNTIL_CONV_RECORD_NAME, $idGoal);
$result[$recordName] = $table;
}
$result[Archiver::getRecordName(Archiver::DAYS_UNTIL_CONV_RECORD_NAME)] = $this->getOverviewFromGoalTables($daysToConversions);
return $result;
}
private function getOverviewFromGoalTables(array $tableByGoal): DataTable
{
$overview = new DataTable();
foreach ($tableByGoal as $idGoal => $table) {
if ($this->isStandardGoal($idGoal)) {
$overview->addDataTable($table);
}
}
return $overview;
}
private function isStandardGoal(int $idGoal): bool
{
return !in_array($idGoal, $this->getEcommerceIdGoals());
}
public function getRecordMetadata(ArchiveProcessor $archiveProcessor): array
{
$goals = API::getInstance()->getGoals($this->getSiteId($archiveProcessor));
$goals = array_keys($goals);
if (Manager::getInstance()->isPluginActivated('Ecommerce')) {
$goals = array_merge($goals, $this->getEcommerceIdGoals());
}
// Overall goal metrics
$goals[] = false;
$records = [];
foreach ($goals as $idGoal) {
$metricsToSum = Goals::getGoalColumns($idGoal);
foreach ($metricsToSum as $metricName) {
$records[] = Record::make(Record::TYPE_NUMERIC, Archiver::getRecordName($metricName, $idGoal));
}
$records[] = Record::make(Record::TYPE_BLOB, Archiver::getRecordName(Archiver::VISITS_UNTIL_RECORD_NAME, $idGoal));
$records[] = Record::make(Record::TYPE_BLOB, Archiver::getRecordName(Archiver::DAYS_UNTIL_CONV_RECORD_NAME, $idGoal));
}
return $records;
}
protected function getConversionsNumericMetrics(array $goals): array
{
$numericRecords = [];
foreach ($goals as $idGoal => $array) {
foreach ($array as $metricId => $value) {
$metricName = Metrics::$mappingFromIdToNameGoal[$metricId];
$recordName = Archiver::getRecordName($metricName, $idGoal);
$numericRecords[$recordName] = $value;
}
}
return $numericRecords;
}
public function isEnabled(ArchiveProcessor $archiveProcessor): bool
{
return $archiveProcessor->getNumberOfVisitsConverted() > 0 || $this->usesEcommerce($archiveProcessor->getParams()->getSite()->getId());
}
}
|
