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
|
<?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\UsersManager;
use Piwik\Config;
use Piwik\Period\PeriodValidator;
use Piwik\Piwik;
use Piwik\Plugins\SitesManager\API as APISitesManager;
use Piwik\Plugins\UsersManager\API as APIUsersManager;
class UserPreferences
{
/**
* @var APIUsersManager
*/
private $api;
public function __construct()
{
$this->api = APIUsersManager::getInstance();
}
/**
* Returns default site ID that Piwik should load.
*
* _Note: This value is a Piwik setting set by each user._
*
* @return bool|int
* @api
*/
public function getDefaultWebsiteId()
{
$defaultReport = $this->getDefaultReport();
if (is_numeric($defaultReport) && Piwik::isUserHasViewAccess($defaultReport)) {
return $defaultReport;
}
$sitesId = APISitesManager::getInstance()->getSitesIdWithAtLeastViewAccess();
if (!empty($sitesId)) {
return $sitesId[0];
}
return false;
}
/**
* Returns default site ID that Piwik should load.
*
* _Note: This value is a Piwik setting set by each user._
*
* @return bool|int
* @api
*/
public function getDefaultReport()
{
// User preference: default website ID to load
$defaultReport = $this->api->getUserPreference(
APIUsersManager::PREFERENCE_DEFAULT_REPORT,
Piwik::getCurrentUserLogin()
);
if (!is_numeric($defaultReport)) {
return $defaultReport;
}
if ($defaultReport && Piwik::isUserHasViewAccess($defaultReport)) {
return $defaultReport;
}
return false;
}
/**
* Returns default date for Piwik reports.
*
* _Note: This value is a Piwik setting set by each user._
*
* @return string `'today'`, `'2010-01-01'`, etc.
* @api
*/
public function getDefaultDate()
{
list($defaultDate, $defaultPeriod) = $this->getDefaultDateAndPeriod();
return $defaultDate;
}
/**
* Returns default period type for Piwik reports.
*
* @param string $defaultDate the default date string from which the default period will be guessed
* @return string `'day'`, `'week'`, `'month'`, `'year'` or `'range'`
* @api
*/
public function getDefaultPeriod($defaultDate = null)
{
list($defaultDate, $defaultPeriod) = $this->getDefaultDateAndPeriod($defaultDate);
return $defaultPeriod;
}
private function getDefaultDateAndPeriod($defaultDate = null)
{
$defaultPeriod = $this->getDefaultPeriodWithoutValidation($defaultDate);
if (! $defaultDate) {
$defaultDate = $this->getDefaultDateWithoutValidation();
}
$periodValidator = new PeriodValidator();
if (! $periodValidator->isPeriodAllowedForUI($defaultPeriod)) {
$defaultDate = $this->getSystemDefaultDate();
$defaultPeriod = $this->getSystemDefaultPeriod();
}
return array($defaultDate, $defaultPeriod);
}
public function getDefaultDateWithoutValidation()
{
// NOTE: a change in this function might mean a change in plugins/UsersManager/javascripts/usersSettings.js as well
$userSettingsDate = $this->api->getUserPreference(
APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE,
Piwik::getCurrentUserLogin()
);
if ($userSettingsDate == 'yesterday') {
return $userSettingsDate;
}
// if last7, last30, etc.
if (
strpos($userSettingsDate, 'last') === 0
|| strpos($userSettingsDate, 'previous') === 0
) {
return $userSettingsDate;
}
return 'today';
}
public function getDefaultPeriodWithoutValidation($defaultDate = null)
{
if (empty($defaultDate)) {
$defaultDate = $this->api->getUserPreference(
APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE,
Piwik::getCurrentUserLogin()
);
}
if (empty($defaultDate)) {
return $this->getSystemDefaultPeriod();
}
if (in_array($defaultDate, array('today', 'yesterday'))) {
return 'day';
}
if (
strpos($defaultDate, 'last') === 0
|| strpos($defaultDate, 'previous') === 0
) {
return 'range';
}
return $defaultDate;
}
private function getSystemDefaultDate()
{
return Config::getInstance()->General['default_day'];
}
private function getSystemDefaultPeriod()
{
return Config::getInstance()->General['default_period'];
}
}
|
