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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\UserId;
use Piwik\Config;
use Piwik\DataArray;
use Piwik\DataTable;
use Piwik\Metrics as PiwikMetrics;
use Piwik\RankingQuery;
/**
* Archiver that aggregates metrics per user ID (user_id field).
*/
class Archiver extends \Piwik\Plugin\Archiver
{
const USERID_ARCHIVE_RECORD = "UserId_users";
const VISITOR_ID_FIELD = 'idvisitor';
const USER_ID_FIELD = 'user_id';
protected $maximumRowsInDataTableLevelZero;
function __construct($processor)
{
parent::__construct($processor);
$this->maximumRowsInDataTableLevelZero = Config::getInstance()->General['datatable_archiving_maximum_rows_userid_users'];
}
/**
* @var DataArray
*/
protected $arrays;
/**
* Array to save visitor IDs for every user ID met during archiving process. We use it to
* fill metadata before actual inserting rows to DB.
* @var array
*/
protected $visitorIdsUserIdsMap = array();
/**
* Archives data for a day period.
*/
public function aggregateDayReport()
{
$this->arrays = new DataArray();
$this->aggregateUsers();
$this->insertDayReports();
}
/**
* Period archiving: simply sums up daily archives
*/
public function aggregateMultipleReports()
{
$dataTableRecords = array(self::USERID_ARCHIVE_RECORD);
$columnsAggregationOperation = null;
$this->getProcessor()->aggregateDataTableRecords(
$dataTableRecords,
$this->maximumRowsInDataTableLevelZero,
$this->maximumRowsInDataTableLevelZero,
$columnToSort = 'nb_visits',
$columnsAggregationOperation,
$columnsToRenameAfterAggregation = null,
$countRowsRecursive = array());
}
/**
* Used to aggregate daily data per user ID
*/
protected function aggregateUsers()
{
$userIdFieldName = self::USER_ID_FIELD;
$visitorIdFieldName = self::VISITOR_ID_FIELD;
$rankingQueryLimit = $this->getRankingQueryLimit();
$rankingQuery = false;
if ($rankingQueryLimit > 0) {
$rankingQuery = new RankingQuery($rankingQueryLimit);
$rankingQuery->addLabelColumn($userIdFieldName);
$rankingQuery->addLabelColumn($visitorIdFieldName);
}
/** @var \Zend_Db_Statement $query */
$query = $this->getLogAggregator()->queryVisitsByDimension(
array(self::USER_ID_FIELD),
"log_visit.$userIdFieldName IS NOT NULL AND log_visit.$userIdFieldName != ''",
array("LOWER(HEX($visitorIdFieldName)) as $visitorIdFieldName"),
$metrics = false,
$rankingQuery,
self::USER_ID_FIELD . ' ASC'
);
if ($query === false) {
return;
}
$rowsCount = 0;
foreach ($query as $row) {
$rowsCount++;
$this->arrays->sumMetricsVisits($row[$userIdFieldName], $row);
$this->rememberVisitorId($row);
}
}
/**
* Insert aggregated daily data serialized
*
* @throws \Exception
*/
protected function insertDayReports()
{
/** @var DataTable $dataTable */
$dataTable = $this->arrays->asDataTable();
$this->setVisitorIds($dataTable);
$report = $dataTable->getSerialized($this->maximumRowsInDataTableLevelZero, null, PiwikMetrics::INDEX_NB_VISITS);
$this->getProcessor()->insertBlobRecord(self::USERID_ARCHIVE_RECORD, $report);
}
/**
* Remember visitor ID per user. We use it to fill metadata before actual inserting rows to DB.
*
* @param array $row
*/
private function rememberVisitorId($row)
{
if (!empty($row[self::USER_ID_FIELD]) && !empty($row[self::VISITOR_ID_FIELD])) {
$this->visitorIdsUserIdsMap[$row[self::USER_ID_FIELD]] = $row[self::VISITOR_ID_FIELD];
}
}
/**
* Fill visitor ID as metadata before actual inserting rows to DB.
*
* @param DataTable $dataTable
*/
private function setVisitorIds(DataTable $dataTable)
{
foreach ($dataTable->getRows() as $row) {
$userId = $row->getColumn('label');
if (isset($this->visitorIdsUserIdsMap[$userId])) {
$row->setMetadata(self::VISITOR_ID_FIELD, $this->visitorIdsUserIdsMap[$userId]);
}
}
}
private function getRankingQueryLimit()
{
$configGeneral = Config::getInstance()->General;
$configLimit = $configGeneral['archiving_ranking_query_row_limit'];
$limit = $configLimit == 0 ? 0 : max(
$configLimit,
$this->maximumRowsInDataTableLevelZero
);
return $limit;
}
}
|
