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
|
<?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 Piwik_SitesManager
*/
use Piwik\Piwik;
use Piwik\Plugin;
/**
*
* @package Piwik_SitesManager
*/
class Piwik_SitesManager extends Plugin
{
const KEEP_URL_FRAGMENT_USE_DEFAULT = 0;
const KEEP_URL_FRAGMENT_YES = 1;
const KEEP_URL_FRAGMENT_NO = 2;
/**
* @see Piwik_Plugin::getListHooksRegistered
*/
public function getListHooksRegistered()
{
return array(
'AssetManager.getJsFiles' => 'getJsFiles',
'AssetManager.getCssFiles' => 'getCssFiles',
'AdminMenu.add' => 'addMenu',
'Common.fetchWebsiteAttributes' => 'recordWebsiteDataInCache',
);
}
function addMenu()
{
Piwik_AddAdminSubMenu('CoreAdminHome_MenuManage', 'SitesManager_MenuSites',
array('module' => 'SitesManager', 'action' => 'index'),
Piwik::isUserHasSomeAdminAccess(),
$order = 1);
}
/**
* Get CSS files
*/
public function getCssFiles(&$cssFiles)
{
$cssFiles[] = "plugins/SitesManager/stylesheets/SitesManager.less";
$cssFiles[] = "plugins/Zeitgeist/stylesheets/base.less";
}
/**
* Get JavaScript files
*/
public function getJsFiles(&$jsFiles)
{
$jsFiles[] = "plugins/SitesManager/javascripts/SitesManager.js";
}
/**
* Hooks when a website tracker cache is flushed (website updated, cache deleted, or empty cache)
* Will record in the tracker config file all data needed for this website in Tracker.
*
* @param array $array
* @param int $idSite
* @return void
*/
public function recordWebsiteDataInCache(&$array, $idSite)
{
$idSite = (int)$idSite;
// add the 'hosts' entry in the website array
$array['hosts'] = $this->getTrackerHosts($idSite);
$website = Piwik_SitesManager_API::getInstance()->getSiteFromId($idSite);
$array['excluded_ips'] = $this->getTrackerExcludedIps($website);
$array['excluded_parameters'] = self::getTrackerExcludedQueryParameters($website);
$array['excluded_user_agents'] = self::getExcludedUserAgents($website);
$array['keep_url_fragment'] = self::shouldKeepURLFragmentsFor($website);
$array['sitesearch'] = $website['sitesearch'];
$array['sitesearch_keyword_parameters'] = $this->getTrackerSearchKeywordParameters($website);
$array['sitesearch_category_parameters'] = $this->getTrackerSearchCategoryParameters($website);
}
/**
* Returns whether we should keep URL fragments for a specific site.
*
* @param array $site DB data for the site.
* @return bool
*/
private static function shouldKeepURLFragmentsFor($site)
{
if ($site['keep_url_fragment'] == self::KEEP_URL_FRAGMENT_YES) {
return true;
} else if ($site['keep_url_fragment'] == self::KEEP_URL_FRAGMENT_NO) {
return false;
}
return Piwik_SitesManager_API::getInstance()->getKeepURLFragmentsGlobal();
}
private function getTrackerSearchKeywordParameters($website)
{
$searchParameters = $website['sitesearch_keyword_parameters'];
if (empty($searchParameters)) {
$searchParameters = Piwik_SitesManager_API::getInstance()->getSearchKeywordParametersGlobal();
}
return explode(",", $searchParameters);
}
private function getTrackerSearchCategoryParameters($website)
{
$searchParameters = $website['sitesearch_category_parameters'];
if (empty($searchParameters)) {
$searchParameters = Piwik_SitesManager_API::getInstance()->getSearchCategoryParametersGlobal();
}
return explode(",", $searchParameters);
}
/**
* Returns the array of excluded IPs to save in the config file
*
* @param array $website
* @return array
*/
private function getTrackerExcludedIps($website)
{
$excludedIps = $website['excluded_ips'];
$globalExcludedIps = Piwik_SitesManager_API::getInstance()->getExcludedIpsGlobal();
$excludedIps .= ',' . $globalExcludedIps;
$ipRanges = array();
foreach (explode(',', $excludedIps) as $ip) {
$ipRange = Piwik_SitesManager_API::getInstance()->getIpsForRange($ip);
if ($ipRange !== false) {
$ipRanges[] = $ipRange;
}
}
return $ipRanges;
}
/**
* Returns the array of excluded user agent substrings for a site. Filters out
* any garbage data & trims each entry.
*
* @param array $website The full set of information for a site.
* @return array
*/
private static function getExcludedUserAgents($website)
{
$excludedUserAgents = Piwik_SitesManager_API::getInstance()->getExcludedUserAgentsGlobal();
if (Piwik_SitesManager_API::getInstance()->isSiteSpecificUserAgentExcludeEnabled()) {
$excludedUserAgents .= ',' . $website['excluded_user_agents'];
}
return self::filterBlankFromCommaSepList($excludedUserAgents);
}
/**
* Returns the array of URL query parameters to exclude from URLs
*
* @param array $website
* @return array
*/
public static function getTrackerExcludedQueryParameters($website)
{
$excludedQueryParameters = $website['excluded_parameters'];
$globalExcludedQueryParameters = Piwik_SitesManager_API::getInstance()->getExcludedQueryParametersGlobal();
$excludedQueryParameters .= ',' . $globalExcludedQueryParameters;
return self::filterBlankFromCommaSepList($excludedQueryParameters);
}
/**
* Trims each element of a comma-separated list of strings, removes empty elements and
* returns the result (as an array).
*
* @param string $parameters The unfiltered list.
* @return array The filtered list of strings as an array.
*/
static private function filterBlankFromCommaSepList($parameters)
{
$parameters = explode(',', $parameters);
$parameters = array_filter($parameters, 'strlen');
$parameters = array_unique($parameters);
return $parameters;
}
/**
* Returns the hosts alias URLs
* @param int $idSite
* @return array
*/
private function getTrackerHosts($idSite)
{
$urls = Piwik_SitesManager_API::getInstance()->getSiteUrlsFromId($idSite);
$hosts = array();
foreach ($urls as $url) {
$url = parse_url($url);
if (isset($url['host'])) {
$hosts[] = $url['host'];
}
}
return $hosts;
}
}
|
