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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
* @version $Id$
*
* @category Piwik_Plugins
* @package Piwik_Transitions
*/
/**
* @package Piwik_Transitions
*/
class Piwik_Transitions extends Piwik_Plugin
{
private $limitBeforeGrouping = 5;
private $totalTransitionsToFollowingActions = 0;
public function getInformation()
{
return array(
'description' => Piwik_Translate('Transitions_PluginDescription'),
'author' => 'Piwik',
'author_homepage' => 'http://piwik.org/',
'version' => Piwik_Version::VERSION,
);
}
function getListHooksRegistered()
{
return array(
'AssetManager.getCssFiles' => 'getCssFiles',
'AssetManager.getJsFiles' => 'getJsFiles'
);
}
public function getCssFiles($notification)
{
$cssFiles = &$notification->getNotificationObject();
$cssFiles[] = 'plugins/Transitions/templates/transitions.css';
}
public function getJsFiles($notification)
{
$jsFiles = &$notification->getNotificationObject();
$jsFiles[] = 'plugins/Transitions/templates/transitions.js';
}
/**
* Get information about external referrers (i.e. search engines, websites & campaigns)
*
* @param $idaction
* @param $actionType
* @param Piwik_ArchiveProcessing_Day $archiveProcessing
* @param $limitBeforeGrouping
* @return Piwik_DataTable
*/
public function queryExternalReferrers($idaction, $actionType, $archiveProcessing,
$limitBeforeGrouping = false)
{
$rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping);
// we generate a single column that contains the interesting data for each referrer.
// the reason we cannot group by referer_* becomes clear when we look at search engine keywords.
// referer_url contains the url from the search engine, referer_keyword the keyword we want to
// group by. when we group by both, we don't get a single column for the keyword but instead
// one column per keyword + search engine url. this way, we could not get the top keywords using
// the ranking query.
$dimension = 'referrer_data';
$rankingQuery->addLabelColumn('referrer_data');
$select = '
CASE referer_type
WHEN '.Piwik_Common::REFERER_TYPE_DIRECT_ENTRY.' THEN ""
WHEN '.Piwik_Common::REFERER_TYPE_SEARCH_ENGINE.' THEN referer_keyword
WHEN '.Piwik_Common::REFERER_TYPE_WEBSITE.' THEN referer_url
WHEN '.Piwik_Common::REFERER_TYPE_CAMPAIGN.' THEN CONCAT(referer_name, " ", referer_keyword)
END AS referrer_data,
referer_type';
// get one limited group per referrer type
$rankingQuery->partitionResultIntoMultipleGroups('referer_type', array(
Piwik_Common::REFERER_TYPE_DIRECT_ENTRY,
Piwik_Common::REFERER_TYPE_SEARCH_ENGINE,
Piwik_Common::REFERER_TYPE_WEBSITE,
Piwik_Common::REFERER_TYPE_CAMPAIGN
));
$orderBy = '`'.Piwik_Archive::INDEX_NB_VISITS.'` DESC';
$type = $this->getColumnTypeSuffix($actionType);
$where = 'visit_entry_idaction_'.$type.' = '.intval($idaction);
$metrics = array(Piwik_Archive::INDEX_NB_VISITS);
$data = $archiveProcessing->queryVisitsByDimension($dimension, $where, $metrics, $orderBy,
$rankingQuery, $select, $selectGeneratesLabelColumn = true);
$referrerData = array();
$referrerSubData = array();
foreach ($data as $referrerType => &$subData)
{
$referrerData[$referrerType] = array(Piwik_Archive::INDEX_NB_VISITS => 0);
if ($referrerType != Piwik_Common::REFERER_TYPE_DIRECT_ENTRY)
{
$referrerSubData[$referrerType] = array();
}
foreach ($subData as &$row)
{
if ($referrerType == Piwik_Common::REFERER_TYPE_SEARCH_ENGINE && empty($row['referrer_data']))
{
$row['referrer_data'] = Piwik_Referers::LABEL_KEYWORD_NOT_DEFINED;
}
$referrerData[$referrerType][Piwik_Archive::INDEX_NB_VISITS] += $row[Piwik_Archive::INDEX_NB_VISITS];
$label = $row['referrer_data'];
if ($label)
{
$referrerSubData[$referrerType][$label] = array(
Piwik_Archive::INDEX_NB_VISITS => $row[Piwik_Archive::INDEX_NB_VISITS]
);
}
}
}
return $archiveProcessing->getDataTableWithSubtablesFromArraysIndexedByLabel($referrerSubData, $referrerData);
}
/**
* Get information about internal referrers (previous pages & loops, i.e. page refreshes)
*
* @param $idaction
* @param $actionType
* @param Piwik_ArchiveProcessing_Day $archiveProcessing
* @param $limitBeforeGrouping
* @return array(previousPages:Piwik_DataTable, loops:integer)
*/
public function queryInternalReferrers($idaction, $actionType, $archiveProcessing,
$limitBeforeGrouping = false)
{
$rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping);
$rankingQuery->addLabelColumn(array('name', 'url_prefix'));
$rankingQuery->setColumnToMarkExcludedRows('is_self');
$rankingQuery->partitionResultIntoMultipleGroups('action_partition', array(0, 1, 2));
$type = $this->getColumnTypeSuffix($actionType);
$mainActionType = Piwik_Tracker_Action::TYPE_ACTION_URL;
$dimension = 'idaction_url_ref';
$isTitle = $actionType == 'title';
if ($isTitle)
{
$mainActionType = Piwik_Tracker_Action::TYPE_ACTION_NAME;
$dimension = 'idaction_name_ref';
}
$addSelect = '
log_action.name, log_action.url_prefix,
CASE WHEN log_link_visit_action.idaction_'.$type.'_ref = '.intval($idaction).' THEN 1 ELSE 0 END AS is_self,
CASE
WHEN log_action.type = '.$mainActionType.' THEN 1
WHEN log_action.type = '.Piwik_Tracker_Action::TYPE_SITE_SEARCH.' THEN 2
ELSE 0
END AS action_partition';
$where = '
log_link_visit_action.idaction_'.$type.' = '.intval($idaction);
if ($dimension == 'idaction_url_ref')
{
// site search referrers are logged with url_ref=NULL
// when we find one, we have to join on name_ref
$dimension = 'IF( idaction_url_ref IS NULL, idaction_name_ref, idaction_url_ref )';
$joinLogActionOn = $dimension;
}
else
{
$joinLogActionOn = $dimension;
$dimension = array($dimension);
}
$orderBy = '`'.Piwik_Archive::INDEX_NB_ACTIONS.'` DESC';
$metrics = array(Piwik_Archive::INDEX_NB_ACTIONS);
$data = $archiveProcessing->queryActionsByDimension($dimension, $where, $metrics, $orderBy,
$rankingQuery, $joinLogActionOn, $addSelect);
$loops = 0;
$nbPageviews = 0;
$previousPagesDataTable = new Piwik_DataTable;
if (isset($data['result'][1]))
{
foreach ($data['result'][1] as &$page)
{
$nbActions = intval($page[Piwik_Archive::INDEX_NB_ACTIONS]);
$previousPagesDataTable->addRow(new Piwik_DataTable_Row(array(
Piwik_DataTable_Row::COLUMNS => array(
'label' => $this->getPageLabel($page, $isTitle),
Piwik_Archive::INDEX_NB_ACTIONS => $nbActions
)
)));
$nbPageviews += $nbActions;
}
}
$previousSearchesDataTable = new Piwik_DataTable;
if (isset($data['result'][2]))
{
foreach ($data['result'][2] as &$search)
{
$nbActions = intval($search[Piwik_Archive::INDEX_NB_ACTIONS]);
$previousSearchesDataTable->addRow(new Piwik_DataTable_Row(array(
Piwik_DataTable_Row::COLUMNS => array(
'label' => $search['name'],
Piwik_Archive::INDEX_NB_ACTIONS => $nbActions
)
)));
$nbPageviews += $nbActions;
}
}
if (isset($data['result'][0]))
{
foreach ($data['result'][0] as &$referrer)
{
$nbPageviews += intval($referrer[Piwik_Archive::INDEX_NB_ACTIONS]);
}
}
if (count($data['excludedFromLimit']))
{
$loops += intval($data['excludedFromLimit'][0][Piwik_Archive::INDEX_NB_ACTIONS]);
$nbPageviews += $loops;
}
return array(
'pageviews' => $nbPageviews,
'previousPages' => $previousPagesDataTable,
'previousSiteSearches' => $previousSearchesDataTable,
'loops' => $loops
);
}
private function getPageLabel(&$pageRecord, $isTitle)
{
if ($isTitle)
{
$label = $pageRecord['name'];
if (empty($label))
{
$label = Piwik_Actions_ArchivingHelper::getUnknownActionName(
Piwik_Tracker_Action::TYPE_ACTION_NAME);
}
}
else
{
$label = Piwik_Tracker_Action::reconstructNormalizedUrl(
$pageRecord['name'], $pageRecord['url_prefix']);
}
return $label;
}
/**
* Get information about the following actions (following pages, site searches, outlinks, downloads)
*
* @param $idaction
* @param $actionType
* @param Piwik_ArchiveProcessing_Day $archiveProcessing
* @param $limitBeforeGrouping
* @return array(followingPages:Piwik_DataTable, outlinks:Piwik_DataTable, downloads:Piwik_DataTable)
*/
public function queryFollowingActions($idaction, $actionType, Piwik_ArchiveProcessing_Day $archiveProcessing,
$limitBeforeGrouping = false)
{
$types = array();
$isTitle = ($actionType == 'title');
if (!$isTitle) {
// specific setup for page urls
$types[Piwik_Tracker_Action::TYPE_ACTION_URL] = 'followingPages';
$dimension = 'IF( idaction_url IS NULL, idaction_name, idaction_url )';
// site search referrers are logged with url=NULL
// when we find one, we have to join on name
$joinLogActionColumn = $dimension;
$addSelect = 'log_action.name, log_action.url_prefix, log_action.type';
} else {
// specific setup for page titles:
$types[Piwik_Tracker_Action::TYPE_ACTION_NAME] = 'followingPages';
// join log_action on name and url and pick depending on url type
// the table joined on url is log_action1
$joinLogActionColumn = array('idaction_url', 'idaction_name');
$dimension = '
CASE
' /* following site search */ . '
WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.idaction
' /* following page view: use page title */ . '
WHEN log_action1.type = '.Piwik_Tracker_Action::TYPE_ACTION_URL.' THEN log_action2.idaction
' /* following download or outlink: use url */ . '
ELSE log_action1.idaction
END
';
$addSelect = '
CASE
' /* following site search */ . '
WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.name
' /* following page view: use page title */ . '
WHEN log_action1.type = '.Piwik_Tracker_Action::TYPE_ACTION_URL.' THEN log_action2.name
' /* following download or outlink: use url */ . '
ELSE log_action1.name
END AS name,
CASE
' /* following site search */ . '
WHEN log_link_visit_action.idaction_url IS NULL THEN log_action2.type
' /* following page view: use page title */ . '
WHEN log_action1.type = '.Piwik_Tracker_Action::TYPE_ACTION_URL.' THEN log_action2.type
' /* following download or outlink: use url */ . '
ELSE log_action1.type
END AS type,
NULL AS url_prefix
';
}
// these types are available for both titles and urls
$types[Piwik_Tracker_Action::TYPE_SITE_SEARCH] = 'followingSiteSearches';
$types[Piwik_Tracker_Action::TYPE_OUTLINK] = 'outlinks';
$types[Piwik_Tracker_Action::TYPE_DOWNLOAD] = 'downloads';
$rankingQuery = new Piwik_RankingQuery($limitBeforeGrouping ? $limitBeforeGrouping : $this->limitBeforeGrouping);
$rankingQuery->addLabelColumn(array('name', 'url_prefix'));
$rankingQuery->partitionResultIntoMultipleGroups('type', array_keys($types));
$type = $this->getColumnTypeSuffix($actionType);
$where = 'log_link_visit_action.idaction_'.$type.'_ref = '.intval($idaction).' AND '
. '(log_link_visit_action.idaction_'.$type.' IS NULL OR '
. 'log_link_visit_action.idaction_'.$type.' != '.intval($idaction).')';
$orderBy = '`'.Piwik_Archive::INDEX_NB_ACTIONS.'` DESC';
$metrics = array(Piwik_Archive::INDEX_NB_ACTIONS);
$data = $archiveProcessing->queryActionsByDimension($dimension, $where, $metrics, $orderBy,
$rankingQuery, $joinLogActionColumn, $addSelect);
$this->totalTransitionsToFollowingActions = 0;
$dataTables = array();
foreach ($types as $type => $recordName)
{
$dataTable = new Piwik_DataTable;
if (isset($data[$type]))
{
foreach ($data[$type] as &$record)
{
$actions = intval($record[Piwik_Archive::INDEX_NB_ACTIONS]);
$dataTable->addRow(new Piwik_DataTable_Row(array(
Piwik_DataTable_Row::COLUMNS => array(
'label' => $this->getPageLabel($record, $isTitle),
Piwik_Archive::INDEX_NB_ACTIONS => $actions
)
)));
$this->totalTransitionsToFollowingActions += $actions;
}
}
$dataTables[$recordName] = $dataTable;
}
return $dataTables;
}
/**
* Get the sum of all transitions to following actions (pages, outlinks, downloads).
* Only works if queryFollowingActions() has been used directly before.
*/
public function getTotalTransitionsToFollowingActions()
{
return $this->totalTransitionsToFollowingActions;
}
private function getColumnTypeSuffix($actionType)
{
if ($actionType == 'title') {
return 'name';
}
return 'url';
}
}
|