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 - 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_API
{
static private $instance = null;
static public function getInstance()
{
if (self::$instance == null)
{
self::$instance = new self;
}
return self::$instance;
}
/**
* This method combines various reports (both from this and from other plugins) and
* returns a complete report. The report is used in the Transitions API to load all
* data at once.
*/
public function getFullReport($pageUrl, $idSite, $period, $date, $segment = false, $limitBeforeGrouping = false)
{
Piwik::checkUserHasViewAccess($idSite);
$pageUrl = Piwik_Common::unsanitizeInputValue($pageUrl);
$report = array(
'generalText' => '',
);
$this->addMainPageMetricsToReport($report, $pageUrl, $idSite, $period, $date, $segment);
$this->addLiveTransitionsDataToReport($report, $pageUrl, $idSite, $period, $date, $segment, $limitBeforeGrouping);
// replace column names in the data tables
$columnNames = array(
'label' => 'url',
Piwik_Archive::INDEX_NB_ACTIONS => 'referrals'
);
$reportNames = array('previousPages', 'followingPages', 'outlinks', 'downloads');
foreach ($reportNames as $reportName)
{
if (isset($report[$reportName]))
{
$report[$reportName]->filter('ReplaceColumnNames', array($columnNames));
}
}
// add general text
$allPageviews = Piwik_Actions_API::getInstance()->get($idSite, $period, $date, $segment, 'nb_pageviews');
$allPageviewsInt = intval($allPageviews->getFirstRow()->getColumn('nb_pageviews'));
$pageviews = $report['pageMetrics']['pageviews'];
$pageviewsShare = round($pageviews / $allPageviewsInt, 1).'%';
$prettyDate = Piwik_Period_Day::advancedFactory($period, $date)->getLocalizedShortString();
$report['generalText'] = htmlentities(Piwik_Translate('Transitions_ShareOfAllPageviews', array($pageviews, $pageviewsShare)))
. '<br /><i>' . htmlentities(Piwik_Translate('General_DateRange').' '.$prettyDate) . '</i>';
return $report;
}
/**
* Add the main metrics (pageviews, exits, bounces) to the full report.
* Data is loaded from Actions.getPageUrls using the label filter.
*/
private function addMainPageMetricsToReport(&$report, $pageUrl, $idSite, $period, $date, $segment)
{
$label = Piwik_Actions::getActionExplodedNames($pageUrl, Piwik_Tracker_Action::TYPE_ACTION_URL);
if (count($label) == 1)
{
$label = $label[0];
}
else
{
$label = array_map('urlencode', $label);
$label = implode('>', $label);
}
$parameters = array(
'method' => 'Actions.getPageUrls',
'idSite' => $idSite,
'period' => $period,
'date' => $date,
'label' => $label,
'format' => 'original',
'serialize' => '0',
'expanded' => '0'
);
if (!empty($segment))
{
$parameters['segment'] = $segment;
}
$url = Piwik_Url::getQueryStringFromParameters($parameters);
$request = new Piwik_API_Request($url);
try
{
/** @var $dataTable Piwik_DataTable */
$dataTable = $request->process();
}
catch(Exception $e)
{
throw new Exception("Actions.getPageUrls returned an error: ".$e->getMessage()."\n");
}
if ($dataTable->getRowsCount() > 0 && ($row = $dataTable->getFirstRow()) !== false)
{
$report['pageMetrics'] = array(
'exits' => intval($row->getColumn('exit_nb_visits')),
'bounces' => intval($row->getColumn('entry_bounce_count'))
);
}
}
/**
* Add transitions data to the report.
* Fake ArchiveProcessing to do the queries live.
*/
private function addLiveTransitionsDataToReport(&$report, $pageUrl, $idSite, $period, $date,
$segment, $limitBeforeGrouping)
{
// get idaction of page url
$actionsPlugin = new Piwik_Actions;
$idaction = $actionsPlugin->getIdActionFromSegment($pageUrl, 'idaction');
// prepare archive processing that can be reused by the archiving code
$archiveProcessing = new Piwik_ArchiveProcessing_Day();
$archiveProcessing->setSite(new Piwik_Site($idSite));
$archiveProcessing->setPeriod(Piwik_Period::advancedFactory($period, $date));
$archiveProcessing->setSegment(new Piwik_Segment($segment, $idSite));
$archiveProcessing->initForLiveUsage();
// launch the archiving code - but live
$transitionsArchiving = new Piwik_Transitions;
$data = $transitionsArchiving->queryInternalReferrers($idaction, $archiveProcessing, $limitBeforeGrouping);
$report['previousPages'] = &$data['previousPages'];
$report['pageMetrics']['loops'] = $data['loops'];
$report['pageMetrics']['pageviews'] = $data['pageviews'];
$data = $transitionsArchiving->queryFollowingActions($idaction, $archiveProcessing, $limitBeforeGrouping);
foreach ($data as $tableName => $table) {
$report[$tableName] = $table;
}
$data = $transitionsArchiving->queryExternalReferrers($idaction, $archiveProcessing, $limitBeforeGrouping);
$report['pageMetrics']['entries'] = 0;
$report['referrers'] = array();
foreach ($data->getRows() as $row)
{
$referrerId = $row->getColumn('label');
$visits = $row->getColumn(Piwik_Archive::INDEX_NB_VISITS);
if ($visits)
{
// load details (i.e. subtables)
$details = array();
if ($idSubTable = $row->getIdSubDataTable())
{
$subTable = Piwik_DataTable_Manager::getInstance()->getTable($idSubTable);
foreach ($subTable->getRows() as $subRow)
{
$details[] = array(
'label' => $subRow->getColumn('label'),
'referrals' => $subRow->getColumn(Piwik_Archive::INDEX_NB_VISITS)
);
}
}
$report['referrers'][] = array(
'label' => $this->getReferrerLabel($referrerId),
'shortName' => Piwik_getRefererTypeFromShortName($referrerId),
'visits' => $visits,
'details' => $details
);
$report['pageMetrics']['entries'] += $visits;
}
}
// if there's no data for referrers, Piwik_API_ResponseBuilder::handleMultiDimensionalArray
// does not detect the multi dimensional array and the data is rendered differently, which
// causes an exception.
if (count($report['referrers']) == 0)
{
$report['referrers'][] = array(
'label' => $this->getReferrerLabel(Piwik_Common::REFERER_TYPE_DIRECT_ENTRY),
'shortName' => Piwik_getRefererTypeLabel(Piwik_Common::REFERER_TYPE_DIRECT_ENTRY),
'visits' => 0
);
}
// sanitize values taken from the actions report in addMainPageMetricsToReport().
// in some cases (e.g. URLs in DB with hash, actions report without hash), multiple
// idactions get mapped to one row in the actions report. in this case, the numbers
// are higher. we compensate for that here.
if (isset($report['pageMetrics']['exits'])) {
$report['pageMetrics']['exitsBefore'] = $report['pageMetrics']['exits'];
$followingActions = $transitionsArchiving->getTotalTransitionsToFollowingActions();
$report['pageMetrics']['exits'] = min($report['pageMetrics']['exits'],
$report['pageMetrics']['pageviews'] - $followingActions);
$report['pageMetrics']['bounces'] = min($report['pageMetrics']['bounces'],
$report['pageMetrics']['exits']);
$report['pageMetrics']['bounces'] = min($report['pageMetrics']['bounces'],
$report['pageMetrics']['entries']);
}
}
private function getReferrerLabel($referrerId) {
switch ($referrerId)
{
case Piwik_Common::REFERER_TYPE_DIRECT_ENTRY:
return Piwik_Transitions_Controller::getTranslation('directEntries');
case Piwik_Common::REFERER_TYPE_SEARCH_ENGINE:
return Piwik_Transitions_Controller::getTranslation('fromSearchEngines');
case Piwik_Common::REFERER_TYPE_WEBSITE:
return Piwik_Transitions_Controller::getTranslation('fromWebsites');
case Piwik_Common::REFERER_TYPE_CAMPAIGN:
return Piwik_Transitions_Controller::getTranslation('fromCampaigns');
default:
return Piwik_Translate('General_Others');
}
}
}
|
