-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
API.php
1468 lines (1286 loc) · 50.4 KB
/
API.php
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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\Plugins\SitesManager;
use Exception;
use Piwik\Access;
use Piwik\Common;
use Piwik\Date;
use Piwik\Db;
use Piwik\IP;
use Piwik\MetricsFormatter;
use Piwik\Network\IPUtils;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\ProxyHttp;
use Piwik\SettingsPiwik;
use Piwik\SettingsServer;
use Piwik\Site;
use Piwik\TaskScheduler;
use Piwik\Tracker;
use Piwik\Tracker\Cache;
use Piwik\Url;
use Piwik\UrlHelper;
/**
* The SitesManager API gives you full control on Websites in Piwik (create, update and delete), and many methods to retrieve websites based on various attributes.
*
* This API lets you create websites via "addSite", update existing websites via "updateSite" and delete websites via "deleteSite".
* When creating websites, it can be useful to access internal codes used by Piwik for currencies via "getCurrencyList", or timezones via "getTimezonesList".
*
* There are also many ways to request a list of websites: from the website ID via "getSiteFromId" or the site URL via "getSitesIdFromSiteUrl".
* Often, the most useful technique is to list all websites that are known to a current user, based on the token_auth, via
* "getSitesWithAdminAccess", "getSitesWithViewAccess" or "getSitesWithAtLeastViewAccess" (which returns both).
*
* Some methods will affect all websites globally: "setGlobalExcludedIps" will set the list of IPs to be excluded on all websites,
* "setGlobalExcludedQueryParameters" will set the list of URL parameters to remove from URLs for all websites.
* The existing values can be fetched via "getExcludedIpsGlobal" and "getExcludedQueryParametersGlobal".
* See also the documentation about <a href='http://piwik.org/docs/manage-websites/' target='_blank'>Managing Websites</a> in Piwik.
* @method static \Piwik\Plugins\SitesManager\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
const DEFAULT_SEARCH_KEYWORD_PARAMETERS = 'q,query,s,search,searchword,k,keyword';
const OPTION_EXCLUDED_IPS_GLOBAL = 'SitesManager_ExcludedIpsGlobal';
const OPTION_DEFAULT_TIMEZONE = 'SitesManager_DefaultTimezone';
const OPTION_DEFAULT_CURRENCY = 'SitesManager_DefaultCurrency';
const OPTION_EXCLUDED_QUERY_PARAMETERS_GLOBAL = 'SitesManager_ExcludedQueryParameters';
const OPTION_SEARCH_KEYWORD_QUERY_PARAMETERS_GLOBAL = 'SitesManager_SearchKeywordParameters';
const OPTION_SEARCH_CATEGORY_QUERY_PARAMETERS_GLOBAL = 'SitesManager_SearchCategoryParameters';
const OPTION_EXCLUDED_USER_AGENTS_GLOBAL = 'SitesManager_ExcludedUserAgentsGlobal';
const OPTION_SITE_SPECIFIC_USER_AGENT_EXCLUDE_ENABLE = 'SitesManager_EnableSiteSpecificUserAgentExclude';
const OPTION_KEEP_URL_FRAGMENTS_GLOBAL = 'SitesManager_KeepURLFragmentsGlobal';
/**
* Returns the javascript tag for the given idSite.
* This tag must be included on every page to be tracked by Piwik
*
* @param int $idSite
* @param string $piwikUrl
* @param bool $mergeSubdomains
* @param bool $groupPageTitlesByDomain
* @param bool $mergeAliasUrls
* @param bool $visitorCustomVariables
* @param bool $pageCustomVariables
* @param bool $customCampaignNameQueryParam
* @param bool $customCampaignKeywordParam
* @param bool $doNotTrack
* @param bool $disableCookies
* @return string The Javascript tag ready to be included on the HTML pages
*/
public function getJavascriptTag($idSite, $piwikUrl = '', $mergeSubdomains = false, $groupPageTitlesByDomain = false,
$mergeAliasUrls = false, $visitorCustomVariables = false, $pageCustomVariables = false,
$customCampaignNameQueryParam = false, $customCampaignKeywordParam = false,
$doNotTrack = false, $disableCookies = false)
{
Piwik::checkUserHasViewAccess($idSite);
if (empty($piwikUrl)) {
$piwikUrl = SettingsPiwik::getPiwikUrl();
}
$piwikUrl = Common::sanitizeInputValues($piwikUrl);
$javascriptGenerator = new Tracker\TrackerCodeGenerator();
$htmlEncoded = $javascriptGenerator->generate($idSite, $piwikUrl, $mergeSubdomains, $groupPageTitlesByDomain,
$mergeAliasUrls, $visitorCustomVariables, $pageCustomVariables,
$customCampaignNameQueryParam, $customCampaignKeywordParam,
$doNotTrack, $disableCookies);
$htmlEncoded = str_replace(array('<br>', '<br />', '<br/>'), '', $htmlEncoded);
return $htmlEncoded;
}
/**
* Returns image link tracking code for a given site with specified options.
*
* @param int $idSite The ID to generate tracking code for.
* @param string $piwikUrl The domain and URL path to the Piwik installation.
* @param int $idGoal An ID for a goal to trigger a conversion for.
* @param int $revenue The revenue of the goal conversion. Only used if $idGoal is supplied.
* @return string The HTML tracking code.
*/
public function getImageTrackingCode($idSite, $piwikUrl = '', $actionName = false, $idGoal = false, $revenue = false)
{
$urlParams = array('idsite' => $idSite, 'rec' => 1);
if ($actionName !== false) {
$urlParams['action_name'] = urlencode(Common::unsanitizeInputValue($actionName));
}
if ($idGoal !== false) {
$urlParams['idGoal'] = $idGoal;
if ($revenue !== false) {
$urlParams['revenue'] = $revenue;
}
}
/**
* Triggered when generating image link tracking code server side. Plugins can use
* this event to customise the image tracking code that is displayed to the
* user.
*
* @param string &$piwikHost The domain and URL path to the Piwik installation, eg,
* `'examplepiwik.com/path/to/piwik'`.
* @param array &$urlParams The query parameters used in the <img> element's src
* URL. See Piwik's image tracking docs for more info.
*/
Piwik::postEvent('SitesManager.getImageTrackingCode', array(&$piwikUrl, &$urlParams));
$piwikUrl = (ProxyHttp::isHttps() ? "https://" : "http://") . $piwikUrl . '/piwik.php';
return "<!-- Piwik Image Tracker-->
<img src=\"$piwikUrl?" . Url::getQueryStringFromParameters($urlParams) . "\" style=\"border:0\" alt=\"\" />
<!-- End Piwik -->";
}
/**
* Returns all websites belonging to the specified group
* @param string $group Group name
* @return array of sites
*/
public function getSitesFromGroup($group)
{
Piwik::checkUserHasSuperUserAccess();
$group = trim($group);
$sites = $this->getModel()->getSitesFromGroup($group);
Site::setSitesFromArray($sites);
return $sites;
}
/**
* Returns the list of website groups, including the empty group
* if no group were specified for some websites
*
* @return array of group names strings
*/
public function getSitesGroups()
{
Piwik::checkUserHasSuperUserAccess();
$groups = $this->getModel()->getSitesGroups();
$cleanedGroups = array_map('trim', $groups);
return $cleanedGroups;
}
/**
* Returns the website information : name, main_url
*
* @throws Exception if the site ID doesn't exist or the user doesn't have access to it
* @param int $idSite
* @return array
*/
public function getSiteFromId($idSite)
{
Piwik::checkUserHasViewAccess($idSite);
$site = $this->getModel()->getSiteFromId($idSite);
Site::setSitesFromArray(array($site));
return $site;
}
private function getModel()
{
return new Model();
}
/**
* Returns the list of all URLs registered for the given idSite (main_url + alias URLs).
*
* @throws Exception if the website ID doesn't exist or the user doesn't have access to it
* @param int $idSite
* @return array list of URLs
*/
public function getSiteUrlsFromId($idSite)
{
Piwik::checkUserHasViewAccess($idSite);
return $this->getModel()->getSiteUrlsFromId($idSite);
}
private function getSitesId()
{
return $this->getModel()->getSitesId();
}
/**
* Returns all websites, requires Super User access
*
* @return array The list of websites, indexed by idsite
*/
public function getAllSites()
{
Piwik::checkUserHasSuperUserAccess();
$sites = $this->getModel()->getAllSites();
$return = array();
foreach ($sites as $site) {
$return[$site['idsite']] = $site;
}
Site::setSitesFromArray($return);
return $return;
}
/**
* Returns the list of all the website IDs registered.
* Requires Super User access.
*
* @return array The list of website IDs
*/
public function getAllSitesId()
{
Piwik::checkUserHasSuperUserAccess();
try {
return API::getInstance()->getSitesId();
} catch (Exception $e) {
// can be called before Piwik tables are created so return empty
return array();
}
}
/**
* Returns the list of the website IDs that received some visits since the specified timestamp.
* Requires Super User access.
*
* @param bool|int $timestamp
* @return array The list of website IDs
*/
public function getSitesIdWithVisits($timestamp = false)
{
Piwik::checkUserHasSuperUserAccess();
if (empty($timestamp)) $timestamp = time();
$time = Date::factory((int)$timestamp)->getDatetime();
$now = Date::now()->addHour(1)->getDatetime();
$result = $this->getModel()->getSitesWithVisits($time, $now);
$idSites = array();
foreach ($result as $idSite) {
$idSites[] = $idSite['idsite'];
}
return $idSites;
}
/**
* Returns the list of websites with the 'admin' access for the current user.
* For the superUser it returns all the websites in the database.
*
* @param bool $fetchAliasUrls
* @return array for each site, an array of information (idsite, name, main_url, etc.)
*/
public function getSitesWithAdminAccess($fetchAliasUrls = false)
{
$sitesId = $this->getSitesIdWithAdminAccess();
$sites = $this->getSitesFromIds($sitesId);
if ($fetchAliasUrls) {
foreach ($sites as &$site) {
$site['alias_urls'] = API::getInstance()->getSiteUrlsFromId($site['idsite']);
}
}
return $sites;
}
/**
* Returns the list of websites with the 'view' access for the current user.
* For the superUser it doesn't return any result because the superUser has admin access on all the websites (use getSitesWithAtLeastViewAccess() instead).
*
* @return array for each site, an array of information (idsite, name, main_url, etc.)
*/
public function getSitesWithViewAccess()
{
$sitesId = $this->getSitesIdWithViewAccess();
return $this->getSitesFromIds($sitesId);
}
/**
* Returns the list of websites with the 'view' or 'admin' access for the current user.
* For the superUser it returns all the websites in the database.
*
* @param bool|int $limit Specify max number of sites to return
* @param bool $_restrictSitesToLogin Hack necessary when runnning scheduled tasks, where "Super User" is forced, but sometimes not desired, see #3017
* @return array array for each site, an array of information (idsite, name, main_url, etc.)
*/
public function getSitesWithAtLeastViewAccess($limit = false, $_restrictSitesToLogin = false)
{
$sitesId = $this->getSitesIdWithAtLeastViewAccess($_restrictSitesToLogin);
return $this->getSitesFromIds($sitesId, $limit);
}
/**
* Returns the list of websites ID with the 'admin' access for the current user.
* For the superUser it returns all the websites in the database.
*
* @return array list of websites ID
*/
public function getSitesIdWithAdminAccess()
{
$sitesId = Access::getInstance()->getSitesIdWithAdminAccess();
return $sitesId;
}
/**
* Returns the list of websites ID with the 'view' access for the current user.
* For the superUser it doesn't return any result because the superUser has admin access on all the websites (use getSitesIdWithAtLeastViewAccess() instead).
*
* @return array list of websites ID
*/
public function getSitesIdWithViewAccess()
{
return Access::getInstance()->getSitesIdWithViewAccess();
}
/**
* Returns the list of websites ID with the 'view' or 'admin' access for the current user.
* For the superUser it returns all the websites in the database.
*
* @param bool $_restrictSitesToLogin
* @return array list of websites ID
*/
public function getSitesIdWithAtLeastViewAccess($_restrictSitesToLogin = false)
{
if (Piwik::hasUserSuperUserAccess() && !TaskScheduler::isTaskBeingExecuted()) {
return Access::getInstance()->getSitesIdWithAtLeastViewAccess();
}
if (!empty($_restrictSitesToLogin)
// Only Super User or logged in user can see viewable sites for a specific login,
// but during scheduled task execution, we sometimes want to restrict sites to
// a different login than the superuser.
&& (Piwik::hasUserSuperUserAccessOrIsTheUser($_restrictSitesToLogin)
|| TaskScheduler::isTaskBeingExecuted())
) {
if (Piwik::hasTheUserSuperUserAccess($_restrictSitesToLogin)) {
return Access::getInstance()->getSitesIdWithAtLeastViewAccess();
}
$accessRaw = Access::getInstance()->getRawSitesWithSomeViewAccess($_restrictSitesToLogin);
$sitesId = array();
foreach ($accessRaw as $access) {
$sitesId[] = $access['idsite'];
}
return $sitesId;
} else {
return Access::getInstance()->getSitesIdWithAtLeastViewAccess();
}
}
/**
* Returns the list of websites from the ID array in parameters.
* The user access is not checked in this method so the ID have to be accessible by the user!
*
* @param array $idSites list of website ID
* @param bool $limit
* @return array
*/
private function getSitesFromIds($idSites, $limit = false)
{
$sites = $this->getModel()->getSitesFromIds($idSites, $limit);
Site::setSitesFromArray($sites);
return $sites;
}
protected function getNormalizedUrls($url)
{
if (strpos($url, 'www.') !== false) {
$urlBis = str_replace('www.', '', $url);
} else {
$urlBis = str_replace('://', '://www.', $url);
}
return array($url, $urlBis);
}
/**
* Returns the list of websites ID associated with a URL.
*
* @param string $url
* @return array list of websites ID
*/
public function getSitesIdFromSiteUrl($url)
{
$url = $this->removeTrailingSlash($url);
list($url, $urlBis) = $this->getNormalizedUrls($url);
if (Piwik::hasUserSuperUserAccess()) {
$ids = $this->getModel()->getAllSitesIdFromSiteUrl($url, $urlBis);
} else {
$login = Piwik::getCurrentUserLogin();
$ids = $this->getModel()->getSitesIdFromSiteUrlHavingAccess($url, $urlBis, $login);
}
return $ids;
}
/**
* Returns all websites with a timezone matching one the specified timezones
*
* @param array $timezones
* @return array
* @ignore
*/
public function getSitesIdFromTimezones($timezones)
{
Piwik::checkUserHasSuperUserAccess();
$timezones = Piwik::getArrayFromApiParameter($timezones);
$timezones = array_unique($timezones);
$ids = $this->getModel()->getSitesFromTimezones($timezones);
$return = array();
foreach ($ids as $id) {
$return[] = $id['idsite'];
}
return $return;
}
/**
* Add a website.
* Requires Super User access.
*
* The website is defined by a name and an array of URLs.
* @param string $siteName Site name
* @param array|string $urls The URLs array must contain at least one URL called the 'main_url' ;
* if several URLs are provided in the array, they will be recorded
* as Alias URLs for this website.
* @param int $ecommerce Is Ecommerce Reporting enabled for this website?
* @param null $siteSearch
* @param string $searchKeywordParameters Comma separated list of search keyword parameter names
* @param string $searchCategoryParameters Comma separated list of search category parameter names
* @param string $excludedIps Comma separated list of IPs to exclude from the reports (allows wildcards)
* @param null $excludedQueryParameters
* @param string $timezone Timezone string, eg. 'Europe/London'
* @param string $currency Currency, eg. 'EUR'
* @param string $group Website group identifier
* @param string $startDate Date at which the statistics for this website will start. Defaults to today's date in YYYY-MM-DD format
* @param null|string $excludedUserAgents
* @param int $keepURLFragments If 1, URL fragments will be kept when tracking. If 2, they
* will be removed. If 0, the default global behavior will be used.
* @see getKeepURLFragmentsGlobal.
* @param string $type The website type, defaults to "website" if not set.
*
* @return int the website ID created
*/
public function addSite($siteName,
$urls,
$ecommerce = null,
$siteSearch = null,
$searchKeywordParameters = null,
$searchCategoryParameters = null,
$excludedIps = null,
$excludedQueryParameters = null,
$timezone = null,
$currency = null,
$group = null,
$startDate = null,
$excludedUserAgents = null,
$keepURLFragments = null,
$type = null)
{
Piwik::checkUserHasSuperUserAccess();
$this->checkName($siteName);
$urls = $this->cleanParameterUrls($urls);
$this->checkUrls($urls);
$this->checkAtLeastOneUrl($urls);
$siteSearch = $this->checkSiteSearch($siteSearch);
list($searchKeywordParameters, $searchCategoryParameters) = $this->checkSiteSearchParameters($searchKeywordParameters, $searchCategoryParameters);
$keepURLFragments = (int)$keepURLFragments;
self::checkKeepURLFragmentsValue($keepURLFragments);
$timezone = trim($timezone);
if (empty($timezone)) {
$timezone = $this->getDefaultTimezone();
}
$this->checkValidTimezone($timezone);
if (empty($currency)) {
$currency = $this->getDefaultCurrency();
}
$this->checkValidCurrency($currency);
$url = $urls[0];
$urls = array_slice($urls, 1);
$bind = array('name' => $siteName,
'main_url' => $url,
);
$bind['excluded_ips'] = $this->checkAndReturnExcludedIps($excludedIps);
$bind['excluded_parameters'] = $this->checkAndReturnCommaSeparatedStringList($excludedQueryParameters);
$bind['excluded_user_agents'] = $this->checkAndReturnCommaSeparatedStringList($excludedUserAgents);
$bind['keep_url_fragment'] = $keepURLFragments;
$bind['timezone'] = $timezone;
$bind['currency'] = $currency;
$bind['ecommerce'] = (int)$ecommerce;
$bind['sitesearch'] = $siteSearch;
$bind['sitesearch_keyword_parameters'] = $searchKeywordParameters;
$bind['sitesearch_category_parameters'] = $searchCategoryParameters;
if (is_null($startDate)) {
$bind['ts_created'] = Date::now()->getDatetime();
} else {
$bind['ts_created'] = Date::factory($startDate)->getDatetime();
}
$bind['type'] = $this->checkAndReturnType($type);
if (!empty($group) && Piwik::hasUserSuperUserAccess()) {
$bind['group'] = trim($group);
} else {
$bind['group'] = "";
}
$idSite = $this->getModel()->createSite($bind);
$this->insertSiteUrls($idSite, $urls);
// we reload the access list which doesn't yet take in consideration this new website
Access::getInstance()->reloadAccess();
$this->postUpdateWebsite($idSite);
/**
* Triggered after a site has been added.
*
* @param int $idSite The ID of the site that was added.
*/
Piwik::postEvent('SitesManager.addSite.end', array($idSite));
return (int) $idSite;
}
private function postUpdateWebsite($idSite)
{
Site::clearCache();
Cache::regenerateCacheWebsiteAttributes($idSite);
SiteUrls::clearSitesCache();
}
/**
* Delete a website from the database, given its Id.
*
* Requires Super User access.
*
* @param int $idSite
* @throws Exception
*/
public function deleteSite($idSite)
{
Piwik::checkUserHasSuperUserAccess();
$idSites = API::getInstance()->getSitesId();
if (!in_array($idSite, $idSites)) {
throw new Exception("website id = $idSite not found");
}
$nbSites = count($idSites);
if ($nbSites == 1) {
throw new Exception(Piwik::translate("SitesManager_ExceptionDeleteSite"));
}
$this->getModel()->deleteSite($idSite);
// we do not delete logs here on purpose (you can run these queries on the log_ tables to delete all data)
Cache::deleteCacheWebsiteAttributes($idSite);
/**
* Triggered after a site has been deleted.
*
* Plugins can use this event to remove site specific values or settings, such as removing all
* goals that belong to a specific website. If you store any data related to a website you
* should clean up that information here.
*
* @param int $idSite The ID of the site being deleted.
*/
Piwik::postEvent('SitesManager.deleteSite.end', array($idSite));
}
/**
* Checks that the array has at least one element
*
* @param array $urls
* @throws Exception
*/
private function checkAtLeastOneUrl($urls)
{
if (!is_array($urls)
|| count($urls) == 0
) {
throw new Exception(Piwik::translate("SitesManager_ExceptionNoUrl"));
}
}
private function checkValidTimezone($timezone)
{
$timezones = $this->getTimezonesList();
foreach (array_values($timezones) as $cities) {
foreach ($cities as $timezoneId => $city) {
if ($timezoneId == $timezone) {
return true;
}
}
}
throw new Exception(Piwik::translate('SitesManager_ExceptionInvalidTimezone', array($timezone)));
}
private function checkValidCurrency($currency)
{
if (!in_array($currency, array_keys($this->getCurrencyList()))) {
throw new Exception(Piwik::translate('SitesManager_ExceptionInvalidCurrency', array($currency, "USD, EUR, etc.")));
}
}
private function checkAndReturnType($type)
{
if (empty($type)) {
$type = Site::DEFAULT_SITE_TYPE;
}
if (!is_string($type)) {
throw new Exception("Invalid website type $type");
}
return $type;
}
/**
* Checks that the submitted IPs (comma separated list) are valid
* Returns the cleaned up IPs
*
* @param string $excludedIps Comma separated list of IP addresses
* @throws Exception
* @return array of IPs
*/
private function checkAndReturnExcludedIps($excludedIps)
{
if (empty($excludedIps)) {
return '';
}
$ips = explode(',', $excludedIps);
$ips = array_map('trim', $ips);
$ips = array_filter($ips, 'strlen');
foreach ($ips as $ip) {
if (!$this->isValidIp($ip)) {
throw new Exception(Piwik::translate('SitesManager_ExceptionInvalidIPFormat', array($ip, "1.2.3.4, 1.2.3.*, or 1.2.3.4/5")));
}
}
$ips = implode(',', $ips);
return $ips;
}
/**
* Add a list of alias Urls to the given idSite
*
* If some URLs given in parameter are already recorded as alias URLs for this website,
* they won't be duplicated. The 'main_url' of the website won't be affected by this method.
*
* @param int $idSite
* @param array|string $urls
* @return int the number of inserted URLs
*/
public function addSiteAliasUrls($idSite, $urls)
{
Piwik::checkUserHasAdminAccess($idSite);
$urls = $this->cleanParameterUrls($urls);
$this->checkUrls($urls);
$urlsInit = $this->getSiteUrlsFromId($idSite);
$toInsert = array_diff($urls, $urlsInit);
$this->insertSiteUrls($idSite, $toInsert);
$this->postUpdateWebsite($idSite);
return count($toInsert);
}
/**
* Set the list of alias Urls for the given idSite
*
* Completely overwrites the current list of URLs with the provided list.
* The 'main_url' of the website won't be affected by this method.
*
* @return int the number of inserted URLs
*/
public function setSiteAliasUrls($idSite, $urls = array())
{
Piwik::checkUserHasAdminAccess($idSite);
$urls = $this->cleanParameterUrls($urls);
$this->checkUrls($urls);
$this->getModel()->deleteSiteAliasUrls($idSite);
$this->insertSiteUrls($idSite, $urls);
$this->postUpdateWebsite($idSite);
return count($urls);
}
/**
* Get the start and end IP addresses for an IP address range
*
* @param string $ipRange IP address range in presentation format
* @return array|false Array( low, high ) IP addresses in presentation format; or false if error
*/
public function getIpsForRange($ipRange)
{
$range = IPUtils::getIPRangeBounds($ipRange);
if ($range === null) {
return false;
}
return array(IPUtils::binaryToStringIP($range[0]), IPUtils::binaryToStringIP($range[1]));
}
/**
* Sets IPs to be excluded from all websites. IPs can contain wildcards.
* Will also apply to websites created in the future.
*
* @param string $excludedIps Comma separated list of IPs to exclude from being tracked (allows wildcards)
* @return bool
*/
public function setGlobalExcludedIps($excludedIps)
{
Piwik::checkUserHasSuperUserAccess();
$excludedIps = $this->checkAndReturnExcludedIps($excludedIps);
Option::set(self::OPTION_EXCLUDED_IPS_GLOBAL, $excludedIps);
Cache::deleteTrackerCache();
return true;
}
/**
* Sets Site Search keyword/category parameter names, to be used on websites which have not specified these values
* Expects Comma separated list of query params names
*
* @param string
* @param string
* @return bool
*/
public function setGlobalSearchParameters($searchKeywordParameters, $searchCategoryParameters)
{
Piwik::checkUserHasSuperUserAccess();
Option::set(self::OPTION_SEARCH_KEYWORD_QUERY_PARAMETERS_GLOBAL, $searchKeywordParameters);
Option::set(self::OPTION_SEARCH_CATEGORY_QUERY_PARAMETERS_GLOBAL, $searchCategoryParameters);
Cache::deleteTrackerCache();
return true;
}
/**
* @return string Comma separated list of URL parameters
*/
public function getSearchKeywordParametersGlobal()
{
Piwik::checkUserHasSomeAdminAccess();
$names = Option::get(self::OPTION_SEARCH_KEYWORD_QUERY_PARAMETERS_GLOBAL);
if ($names === false) {
$names = self::DEFAULT_SEARCH_KEYWORD_PARAMETERS;
}
if (empty($names)) {
$names = '';
}
return $names;
}
/**
* @return string Comma separated list of URL parameters
*/
public function getSearchCategoryParametersGlobal()
{
Piwik::checkUserHasSomeAdminAccess();
return Option::get(self::OPTION_SEARCH_CATEGORY_QUERY_PARAMETERS_GLOBAL);
}
/**
* Returns the list of URL query parameters that are excluded from all websites
*
* @return string Comma separated list of URL parameters
*/
public function getExcludedQueryParametersGlobal()
{
Piwik::checkUserHasSomeViewAccess();
return Option::get(self::OPTION_EXCLUDED_QUERY_PARAMETERS_GLOBAL);
}
/**
* Returns the list of user agent substrings to look for when excluding visits for
* all websites. If a visitor's user agent string contains one of these substrings,
* their visits will not be included.
*
* @return string Comma separated list of strings.
*/
public function getExcludedUserAgentsGlobal()
{
Piwik::checkUserHasSomeAdminAccess();
return Option::get(self::OPTION_EXCLUDED_USER_AGENTS_GLOBAL);
}
/**
* Sets list of user agent substrings to look for when excluding visits. For more info,
* @see getExcludedUserAgentsGlobal.
*
* @param string $excludedUserAgents Comma separated list of strings. Each element is trimmed,
* and empty strings are removed.
*/
public function setGlobalExcludedUserAgents($excludedUserAgents)
{
Piwik::checkUserHasSuperUserAccess();
// update option
$excludedUserAgents = $this->checkAndReturnCommaSeparatedStringList($excludedUserAgents);
Option::set(self::OPTION_EXCLUDED_USER_AGENTS_GLOBAL, $excludedUserAgents);
// make sure tracker cache will reflect change
Cache::deleteTrackerCache();
}
/**
* Returns true if site-specific user agent exclusion has been enabled. If it hasn't,
* only the global user agent substrings (see @setGlobalExcludedUserAgents) will be used.
*
* @return bool
*/
public function isSiteSpecificUserAgentExcludeEnabled()
{
Piwik::checkUserHasSomeAdminAccess();
return (bool)Option::get(self::OPTION_SITE_SPECIFIC_USER_AGENT_EXCLUDE_ENABLE);
}
/**
* Sets whether it should be allowed to exclude different user agents for different
* websites.
*
* @param bool $enabled
*/
public function setSiteSpecificUserAgentExcludeEnabled($enabled)
{
Piwik::checkUserHasSuperUserAccess();
// update option
Option::set(self::OPTION_SITE_SPECIFIC_USER_AGENT_EXCLUDE_ENABLE, $enabled);
// make sure tracker cache will reflect change
Cache::deleteTrackerCache();
}
/**
* Returns true if the default behavior is to keep URL fragments when tracking,
* false if otherwise.
*
* @return bool
*/
public function getKeepURLFragmentsGlobal()
{
Piwik::checkUserHasSomeViewAccess();
return (bool)Option::get(self::OPTION_KEEP_URL_FRAGMENTS_GLOBAL);
}
/**
* Sets whether the default behavior should be to keep URL fragments when
* tracking or not.
*
* @param $enabled bool If true, the default behavior will be to keep URL
* fragments when tracking. If false, the default
* behavior will be to remove them.
*/
public function setKeepURLFragmentsGlobal($enabled)
{
Piwik::checkUserHasSuperUserAccess();
// update option
Option::set(self::OPTION_KEEP_URL_FRAGMENTS_GLOBAL, $enabled);
// make sure tracker cache will reflect change
Cache::deleteTrackerCache();
}
/**
* Sets list of URL query parameters to be excluded on all websites.
* Will also apply to websites created in the future.
*
* @param string $excludedQueryParameters Comma separated list of URL query parameters to exclude from URLs
* @return bool
*/
public function setGlobalExcludedQueryParameters($excludedQueryParameters)
{
Piwik::checkUserHasSuperUserAccess();
$excludedQueryParameters = $this->checkAndReturnCommaSeparatedStringList($excludedQueryParameters);
Option::set(self::OPTION_EXCLUDED_QUERY_PARAMETERS_GLOBAL, $excludedQueryParameters);
Cache::deleteTrackerCache();
return true;
}
/**
* Returns the list of IPs that are excluded from all websites
*
* @return string Comma separated list of IPs
*/
public function getExcludedIpsGlobal()
{
Piwik::checkUserHasSomeAdminAccess();
return Option::get(self::OPTION_EXCLUDED_IPS_GLOBAL);
}
/**
* Returns the default currency that will be set when creating a website through the API.
*
* @return string Currency ID eg. 'USD'
*/
public function getDefaultCurrency()
{
Piwik::checkUserHasSomeAdminAccess();
$defaultCurrency = Option::get(self::OPTION_DEFAULT_CURRENCY);
if ($defaultCurrency) {
return $defaultCurrency;
}
return 'USD';
}
/**
* Sets the default currency that will be used when creating websites
*
* @param string $defaultCurrency Currency code, eg. 'USD'
* @return bool
*/
public function setDefaultCurrency($defaultCurrency)
{
Piwik::checkUserHasSuperUserAccess();
$this->checkValidCurrency($defaultCurrency);
Option::set(self::OPTION_DEFAULT_CURRENCY, $defaultCurrency);
return true;
}
/**
* Returns the default timezone that will be set when creating a website through the API.
* Via the UI, if the default timezone is not UTC, it will be pre-selected in the drop down
*
* @return string Timezone eg. UTC+7 or Europe/Paris
*/
public function getDefaultTimezone()
{
$defaultTimezone = Option::get(self::OPTION_DEFAULT_TIMEZONE);
if ($defaultTimezone) {
return $defaultTimezone;
}
return 'UTC';
}
/**
* Sets the default timezone that will be used when creating websites
*
* @param string $defaultTimezone Timezone string eg. Europe/Paris or UTC+8
* @return bool
*/
public function setDefaultTimezone($defaultTimezone)
{
Piwik::checkUserHasSuperUserAccess();
$this->checkValidTimezone($defaultTimezone);
Option::set(self::OPTION_DEFAULT_TIMEZONE, $defaultTimezone);
return true;