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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugin;
use Piwik\Cache\PluginAwareStaticCache;
use Piwik\Common;
use Piwik\Db;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\Tracker\Request;
use Piwik\Tracker\Visitor;
use Piwik\Tracker\Action;
use Piwik\Translate;
/**
* @api
* @since 2.5.0
*/
abstract class VisitDimension
{
protected $name;
protected $fieldName = '';
protected $fieldType = '';
protected $segments = array();
protected function configureSegments()
{
}
public function hasImplementedEvent($method)
{
$reflectionObject = new \ReflectionObject($this);
$declaringClass = $reflectionObject->getMethod($method)->getDeclaringClass();
return get_class() !== $declaringClass->name;
}
public function install()
{
try {
if ($this->isHandlingLogVisit()) {
$sql = "ALTER TABLE `" . Common::prefixTable("log_visit") . "` ADD `$this->fieldName` $this->fieldType";
Db::exec($sql);
}
} catch (\Exception $e) {
if (!Db::get()->isErrNo($e, '1060')) {
throw $e;
}
}
try {
if ($this->isHandlingLogConversion()) {
$sql = "ALTER TABLE `" . Common::prefixTable("log_conversion") . "` ADD `$this->fieldName` $this->fieldType";
Db::exec($sql);
}
} catch (\Exception $e) {
if (!Db::get()->isErrNo($e, '1060')) {
throw $e;
}
}
}
private function isHandlingLogVisit()
{
if (empty($this->fieldName) || empty($this->fieldType)) {
return false;
}
return $this->hasImplementedEvent('onNewVisit')
|| $this->hasImplementedEvent('onExistingVisit')
|| $this->hasImplementedEvent('onConvertedVisit');
}
private function isHandlingLogConversion()
{
if (empty($this->fieldName) || empty($this->fieldType)) {
return false;
}
return $this->hasImplementedEvent('onRecordGoal');
}
public function uninstall()
{
if (empty($this->fieldName) || empty($this->fieldType)) {
return;
}
try {
if ($this->isHandlingLogVisit()) {
$sql = "ALTER TABLE `" . Common::prefixTable("log_visit") . "` DROP COLUMN `$this->fieldName`";
Db::exec($sql);
}
} catch (\Exception $e) {
if (!Db::get()->isErrNo($e, '1091')) {
throw $e;
}
}
try {
if ($this->isHandlingLogConversion()) {
$sql = "ALTER TABLE `" . Common::prefixTable("log_conversion") . "` DROP COLUMN `$this->fieldName`";
Db::exec($sql);
}
} catch (\Exception $e) {
if (!Db::get()->isErrNo($e, '1091')) {
throw $e;
}
}
}
protected function addSegment(Segment $segment)
{
$sqlSegment = $segment->getSqlSegment();
if (!empty($this->fieldName) && empty($sqlSegment)) {
$segment->setSqlSegment('log_visit.' . $this->fieldName);
}
$type = $segment->getType();
if (empty($type)) {
$segment->setType(Segment::TYPE_DIMENSION);
}
$this->segments[] = $segment;
}
/**
* @return Segment[]
*/
public function getSegments()
{
if (empty($this->segments)) {
$this->configureSegments();
}
return $this->segments;
}
public function getFieldName()
{
return $this->fieldName;
}
public function getRequiredVisitFields()
{
return array();
}
/**
* @param Request $request
* @param Visitor $visitor
* @param Action|null $action
* @return mixed
*/
public function onNewVisit(Request $request, Visitor $visitor, $action)
{
return false;
}
public function onExistingVisit(Request $request, Visitor $visitor, $action)
{
return false;
}
public function onConvertedVisit(Request $request, Visitor $visitor, $action)
{
return false;
}
public function onRecordGoal(Request $request, Visitor $visitor, $action)
{
return false;
}
abstract public function getName();
/** @return \Piwik\Plugin\VisitDimension[] */
public static function getAllDimensions()
{
$cache = new PluginAwareStaticCache('VisitDimensions');
if (!$cache->has()) {
$plugins = PluginManager::getInstance()->getLoadedPlugins();
$instances = array();
foreach ($plugins as $plugin) {
foreach (self::getDimensions($plugin) as $instance) {
$instances[] = $instance;
}
}
usort($instances, array('self', 'sortByRequiredFields'));
$cache->set($instances);
}
return $cache->get();
}
public static function sortByRequiredFields($a, $b)
{
$fields = $a->getRequiredVisitFields();
if (empty($fields)) {
return -1;
}
if (!empty($fields) && in_array($b->getFieldName(), $fields)) {
return 1;
}
return 0;
}
/** @return \Piwik\Plugin\VisitDimension[] */
public static function getDimensions(\Piwik\Plugin $plugin)
{
$dimensions = $plugin->findMultipleComponents('Columns', '\\Piwik\\Plugin\\VisitDimension');
$instances = array();
foreach ($dimensions as $dimension) {
$instances[] = new $dimension();
}
return $instances;
}
}
|
