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
|
<?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\CoreHome\Columns;
use Piwik\Cache;
use Piwik\Columns\DimensionSegmentFactory;
use Piwik\DataTable;
use Piwik\DataTable\Map;
use Piwik\Metrics;
use Piwik\Plugin;
use Piwik\Plugin\Dimension\VisitDimension;
use Piwik\Plugins\Live\Live;
use Piwik\Segment\SegmentsList;
use Piwik\Tracker\Request;
use Piwik\Tracker\Visitor;
use Piwik\Tracker\Action;
/**
* UserId dimension.
*/
class UserId extends VisitDimension
{
public const MAXLENGTH = 200;
/**
* @var string
*/
protected $columnName = 'user_id';
protected $type = self::TYPE_TEXT;
protected $allowAnonymous = false;
protected $segmentName = 'userId';
protected $nameSingular = 'General_UserId';
protected $namePlural = 'General_UserIds';
protected $acceptValues = 'UserId_UserIdSegmentHelp';
public function __construct()
{
$this->columnType = 'VARCHAR(' . self::MAXLENGTH . ') NULL';
if (Plugin\Manager::getInstance()->isPluginActivated('UserId')) {
$this->suggestedValuesApi = 'UserId.getUsers';
}
}
public function configureSegments(SegmentsList $segmentsList, DimensionSegmentFactory $dimensionSegmentFactory)
{
// Configure userId segment only if visitor profile is available
if (Live::isVisitorProfileEnabled()) {
parent::configureSegments($segmentsList, $dimensionSegmentFactory);
}
}
/**
* @param Request $request
* @param Visitor $visitor
* @param Action|null $action
* @return mixed|false
*/
public function onNewVisit(Request $request, Visitor $visitor, $action)
{
$value = $request->getForcedUserId();
if (!empty($value)) {
return mb_substr($value, 0, self::MAXLENGTH);
}
return $value;
}
/**
* @param Request $request
* @param Visitor $visitor
* @param Action|null $action
*
* @return mixed|false
*/
public function onExistingVisit(Request $request, Visitor $visitor, $action)
{
return $this->onNewVisit($request, $visitor, $action);
}
public function isUsedInAtLeastOneSite($idSites, $period, $date)
{
if ($period === 'day' || $period === 'week') {
$period = 'month';
}
if ($period === 'range') {
$period = 'day';
}
if (!empty($idSites)) {
foreach ($idSites as $idSite) {
if ($this->isUsedInSiteCached($idSite, $period, $date)) {
return true;
}
}
}
return false;
}
private function isUsedInSiteCached($idSite, $period, $date)
{
$cache = Cache::getTransientCache();
$key = sprintf('%d.%s.%s', $idSite, $period, $date);
if (!$cache->contains($key)) {
$result = $this->isUsedInSite($idSite, $period, $date);
$cache->save($key, $result);
}
return $cache->fetch($key);
}
private function isUsedInSite($idSite, $period, $date)
{
$result = \Piwik\API\Request::processRequest('VisitsSummary.get', [
'columns' => 'nb_users',
'idSite' => $idSite,
'period' => $period,
'date' => $date,
'segment' => false,
], $default = []);
return $this->hasDataTableUsers($result);
}
public function hasDataTableUsers(DataTable\DataTableInterface $result)
{
if ($result instanceof Map) {
foreach ($result->getDataTables() as $table) {
if ($this->hasDataTableUsers($table)) {
return true;
}
}
}
if (!$result->getRowsCount()) {
return false;
}
$firstRow = $result->getFirstRow();
if ($firstRow instanceof DataTable\Row && $firstRow->hasColumn(Metrics::INDEX_NB_USERS)) {
$metric = Metrics::INDEX_NB_USERS;
} else {
$metric = 'nb_users';
}
$numUsers = $result->getColumn($metric);
$numUsers = array_sum($numUsers);
return !empty($numUsers);
}
}
|
