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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik_Plugins
* @package Overlay
*/
namespace Piwik\Plugins\Overlay;
use Exception;
use Piwik\Config;
use Piwik\Piwik;
use Piwik\Access;
use Piwik\DataTable;
use Piwik\Tracker\Action;
use Piwik\Plugins\SitesManager\SitesManager;
use Piwik\Plugins\SitesManager\API as SitesManagerAPI;
use Piwik\Plugins\Transitions\API as TransitionsAPI;
class API
{
private static $instance = null;
/**
* Get Singleton instance
* @return \Piwik\Plugins\Overlay\API
*/
public static function getInstance()
{
if (self::$instance == null) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Get translation strings
*/
public function getTranslations($idSite)
{
$this->authenticate($idSite);
$translations = array(
'oneClick' => 'Overlay_OneClick',
'clicks' => 'Overlay_Clicks',
'clicksFromXLinks' => 'Overlay_ClicksFromXLinks',
'link' => 'Overlay_Link'
);
return array_map('Piwik_Translate', $translations);
}
/**
* Get excluded query parameters for a site.
* This information is used for client side url normalization.
*/
public function getExcludedQueryParameters($idSite)
{
$this->authenticate($idSite);
$sitesManager = SitesManagerAPI::getInstance();
$site = $sitesManager->getSiteFromId($idSite);
try {
return SitesManager::getTrackerExcludedQueryParameters($site);
} catch (Exception $e) {
// an exception is thrown when the user has no view access.
// do not throw the exception to the outside.
return array();
}
}
/**
* Get following pages of a url.
* This is done on the logs - not the archives!
*
* Note: if you use this method via the regular API, the number of results will be limited.
* Make sure, you set filter_limit=-1 in the request.
*/
public function getFollowingPages($url, $idSite, $period, $date, $segment = false)
{
$this->authenticate($idSite);
$url = Action::excludeQueryParametersFromUrl($url, $idSite);
// we don't unsanitize $url here. it will be done in the Transitions plugin.
$resultDataTable = new DataTable;
try {
$limitBeforeGrouping = Config::getInstance()->General['overlay_following_pages_limit'];
$transitionsReport = TransitionsAPI::getInstance()->getTransitionsForAction(
$url, $type = 'url', $idSite, $period, $date, $segment, $limitBeforeGrouping,
$part = 'followingActions', $returnNormalizedUrls = true);
} catch (Exception $e) {
return $resultDataTable;
}
$reports = array('followingPages', 'outlinks', 'downloads');
foreach ($reports as $reportName) {
if (!isset($transitionsReport[$reportName])) {
continue;
}
foreach ($transitionsReport[$reportName]->getRows() as $row) {
// don't touch the row at all for performance reasons
$resultDataTable->addRow($row);
}
}
return $resultDataTable;
}
/** Do cookie authentication. This way, the token can remain secret. */
private function authenticate($idSite)
{
$notification = null;
Piwik_PostEvent('FrontController.initAuthenticationObject',
array(&$notification, $allowCookieAuthentication = true));
$auth = \Zend_Registry::get('auth');
$success = Access::getInstance()->reloadAccess($auth);
if (!$success) {
throw new Exception('Authentication failed');
}
Piwik::checkUserHasViewAccess($idSite);
}
}
|
