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
|
<?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;
use Exception;
use Piwik\Container\StaticContainer;
use Piwik\Exception\UnexpectedWebsiteFoundException;
use Piwik\Intl\Data\Provider\CurrencyDataProvider;
use Piwik\Plugins\SitesManager\API;
/**
* Provides access to individual [site entity](/guides/persistence-and-the-mysql-backend#websites-aka-sites) data
* (including name, URL, etc.).
*
* **Data Cache**
*
* Site data can be cached in order to avoid performing too many queries.
* If a method needs many site entities, it is more efficient to query all of what
* you need beforehand via the **SitesManager** API, then cache it using {@link setSites()} or
* {@link setSitesFromArray()}.
*
* Subsequent calls to `new Site($id)` will use the data in the cache instead of querying the database.
*
* ### Examples
*
* **Basic usage**
*
* $site = new Site($idSite);
* $name = $site->getName();
*
* **Without allocation**
*
* $name = Site::getNameFor($idSite);
*
* @api
*/
class Site
{
const DEFAULT_SITE_TYPE = "website";
private static $intProperties = [
'idsite',
'ecommerce',
'sitesearch',
'exclude_unknown_urls',
'keep_url_fragment',
];
/**
* @var int|null
*/
protected $id = null;
/**
* @var array
*/
protected static $infoSites = array();
private $site = array();
/**
* Constructor.
*
* @param int $idsite The ID of the site we want data for.
* @throws UnexpectedWebsiteFoundException
*/
public function __construct($idsite)
{
$this->id = (int) $idsite;
if (!empty(self::$infoSites[$this->id])) {
$site = self::$infoSites[$this->id];
} else {
$site = API::getInstance()->getSiteFromId($this->id);
if (empty($site)) {
throw new UnexpectedWebsiteFoundException('The requested website id = ' . (int)$this->id . ' couldn\'t be found');
}
}
$sites = array(&$site);
self::triggerSetSitesEvent($sites);
self::setSiteFromArray($this->id, $site);
$this->site = $site;
// for serialized format to be predictable across php/mysql/pdo/mysqli versions, make sure the int props stay ints
foreach (self::$intProperties as $propertyName) {
$this->site[$propertyName] = (int)$this->site[$propertyName];
}
}
/**
* Sets the cached site data with an array that associates site IDs with
* individual site data.
*
* @param array $sites The array of sites data. Indexed by site ID. eg,
*
* array('1' => array('name' => 'Site 1', ...),
* '2' => array('name' => 'Site 2', ...))`
*/
public static function setSites($sites)
{
self::triggerSetSitesEvent($sites);
foreach ($sites as $idsite => $site) {
self::setSiteFromArray($idsite, $site);
}
}
private static function triggerSetSitesEvent(&$sites)
{
/**
* Triggered so plugins can modify website entities without modifying the database.
*
* This event should **not** be used to add data that is expensive to compute. If you
* need to make HTTP requests or query the database for more information, this is not
* the place to do it.
*
* **Example**
*
* Piwik::addAction('Site.setSites', function (&$sites) {
* foreach ($sites as &$site) {
* $site['name'] .= " (original)";
* }
* });
*
* @param array $sites An array of website entities. [Learn more.](/guides/persistence-and-the-mysql-backend#websites-aka-sites)
*
* This is not yet public as it doesn't work 100% accurately. Eg if `setSiteFromArray()` is called directly this event will not be triggered.
* @ignore
*/
Piwik::postEvent('Site.setSites', array(&$sites));
}
/**
* Sets a site information in memory (statically cached).
*
* Plugins can filter the website attributes before it is cached, eg. to change the website name,
* creation date, etc.
*
* @param $idSite
* @param $infoSite
* @throws Exception if website or idsite is invalid
* @internal
*/
public static function setSiteFromArray($idSite, $infoSite)
{
if (empty($idSite) || empty($infoSite)) {
throw new UnexpectedWebsiteFoundException("An unexpected website was found in the request: website id was set to '$idSite' .");
}
self::$infoSites[$idSite] = $infoSite;
}
/**
* Sets the cached Site data with a non-associated array of site data.
*
* This method will trigger the `Sites.setSites` event modifying `$sites` before setting cached
* site data. In other words, this method will change the site data before it is cached and then
* return the modified array.
*
* @param array $sites The array of sites data. eg,
*
* array(
* array('idsite' => '1', 'name' => 'Site 1', ...),
* array('idsite' => '2', 'name' => 'Site 2', ...),
* )
* @return array The modified array.
* @deprecated
* @internal
*/
public static function setSitesFromArray($sites)
{
self::triggerSetSitesEvent($sites);
foreach ($sites as $site) {
$idSite = null;
if (!empty($site['idsite'])) {
$idSite = $site['idsite'];
}
self::setSiteFromArray($idSite, $site);
}
return $sites;
}
/**
* The Multisites reports displays the first calendar date as the earliest day available for all websites.
* Also, today is the later "today" available across all timezones.
* @param array $siteIds Array of IDs for each site being displayed.
* @return Date[] of two Date instances. First is the min-date & the second
* is the max date.
* @ignore
*/
public static function getMinMaxDateAcrossWebsites($siteIds)
{
$siteIds = self::getIdSitesFromIdSitesString($siteIds);
$now = Date::now();
$minDate = null;
$maxDate = $now->subDay(1)->getTimestamp();
foreach ($siteIds as $idsite) {
// look for 'now' in the website's timezone
$timezone = Site::getTimezoneFor($idsite);
$date = Date::adjustForTimezone($now->getTimestamp(), $timezone);
if ($date > $maxDate) {
$maxDate = $date;
}
// look for the absolute minimum date
$creationDate = Site::getCreationDateFor($idsite);
$date = Date::adjustForTimezone(strtotime($creationDate), $timezone);
if (is_null($minDate) || $date < $minDate) {
$minDate = $date;
}
}
return array(Date::factory($minDate), Date::factory($maxDate));
}
/**
* Returns a string representation of the site this instance references.
*
* Useful for debugging.
*
* @return string
*/
public function __toString()
{
return "site id=" . $this->getId() . ",
name=" . $this->getName() . ",
url = " . $this->getMainUrl() . ",
IPs excluded = " . $this->getExcludedIps() . ",
timezone = " . $this->getTimezone() . ",
currency = " . $this->getCurrency() . ",
creation date = " . $this->getCreationDate();
}
/**
* Returns the name of the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getName()
{
return $this->get('name');
}
/**
* Returns the main url of the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getMainUrl()
{
return $this->get('main_url');
}
/**
* Returns the id of the site.
*
* @return int
* @throws Exception if data for the site cannot be found.
*/
public function getId()
{
return $this->id;
}
/**
* Returns a site property by name.
*
* @param string $name Name of the property to return (eg, `'main_url'` or `'name'`).
* @return mixed
* @throws Exception
*/
protected function get($name)
{
if (isset($this->site[$name])) {
return $this->site[$name];
}
throw new Exception("The property $name could not be found on the website ID " . (int)$this->id);
}
/**
* Returns the website type (by default `"website"`, which means it is a single website).
*
* @return string
*/
public function getType()
{
$type = $this->get('type');
return $type;
}
/**
* Returns the creation date of the site.
*
* @return Date
* @throws Exception if data for the site cannot be found.
*/
public function getCreationDate()
{
$date = $this->get('ts_created');
return Date::factory($date);
}
/**
* Returns the timezone of the size.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getTimezone()
{
return $this->get('timezone');
}
/**
* Returns the currency of the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getCurrency()
{
return $this->get('currency');
}
/**
* Returns the excluded ips of the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getExcludedIps()
{
return $this->get('excluded_ips');
}
/**
* Returns the excluded query parameters of the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getExcludedQueryParameters()
{
return $this->get('excluded_parameters');
}
/**
* Returns whether ecommerce is enabled for the site.
*
* @return bool
* @throws Exception if data for the site cannot be found.
*/
public function isEcommerceEnabled()
{
return $this->get('ecommerce') == 1;
}
/**
* Returns the site search keyword query parameters for the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getSearchKeywordParameters()
{
return $this->get('sitesearch_keyword_parameters');
}
/**
* Returns the site search category query parameters for the site.
*
* @return string
* @throws Exception if data for the site cannot be found.
*/
public function getSearchCategoryParameters()
{
return $this->get('sitesearch_category_parameters');
}
/**
* Returns whether Site Search Tracking is enabled for the site.
*
* @return bool
* @throws Exception if data for the site cannot be found.
*/
public function isSiteSearchEnabled()
{
return $this->get('sitesearch') == 1;
}
/**
* Returns the user that created this site.
*
* @return string|null If null, the site was created before the creation user was tracked.
*/
public function getCreatorLogin()
{
return $this->get('creator_login');
}
/**
* Checks the given string for valid site IDs and returns them as an array.
*
* @param string|array $ids Comma separated idSite list, eg, `'1,2,3,4'` or an array of IDs, eg,
* `array(1, 2, 3, 4)`.
* @param bool|string $_restrictSitesToLogin Implementation detail. Used only when running as a scheduled task.
* @return array An array of valid, unique integers.
*/
public static function getIdSitesFromIdSitesString($ids, $_restrictSitesToLogin = false)
{
if ($ids === 'all') {
return API::getInstance()->getSitesIdWithAtLeastViewAccess($_restrictSitesToLogin);
}
if (is_bool($ids)) {
return array();
}
if (!is_array($ids)) {
$ids = explode(',', $ids);
}
$validIds = array();
foreach ($ids as $id) {
$id = trim($id);
if (!empty($id) && is_numeric($id) && $id > 0) {
$validIds[] = $id;
}
}
$validIds = array_filter($validIds);
$validIds = array_unique($validIds);
return $validIds;
}
/**
* Clears the site data cache.
*
* See also {@link setSites()} and {@link setSitesFromArray()}.
*/
public static function clearCache()
{
self::$infoSites = array();
}
/**
* Clears the site data cache.
*
* See also {@link setSites()} and {@link setSitesFromArray()}.
*/
public static function clearCacheForSite($idSite)
{
$idSite = (int)$idSite;
unset(self::$infoSites[$idSite]);
}
/**
* Utility function. Returns the value of the specified field for the
* site with the specified ID.
*
* @param int $idsite The ID of the site whose data is being accessed.
* @param string $field The name of the field to get.
* @return string
*/
protected static function getFor($idsite, $field)
{
if (!isset(self::$infoSites[$idsite])) {
$site = API::getInstance()->getSiteFromId($idsite);
self::setSiteFromArray($idsite, $site);
}
return self::$infoSites[$idsite][$field];
}
/**
* Returns all websites pre-cached
*
* @ignore
*/
public static function getSites()
{
return self::$infoSites;
}
/**
* @ignore
*/
public static function getSite($idsite)
{
$idsite = (int)$idsite;
if (!isset(self::$infoSites[$idsite])) {
$site = API::getInstance()->getSiteFromId($idsite);
self::setSiteFromArray($idsite, $site);
}
return self::$infoSites[$idsite];
}
/**
* Returns the name of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getNameFor($idsite)
{
return self::getFor($idsite, 'name');
}
/**
* Returns the group of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getGroupFor($idsite)
{
return self::getFor($idsite, 'group');
}
/**
* Returns the timezone of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getTimezoneFor($idsite)
{
return self::getFor($idsite, 'timezone');
}
/**
* Returns the type of the site with the specified ID.
*
* @param $idsite
* @return string
*/
public static function getTypeFor($idsite)
{
return self::getFor($idsite, 'type');
}
/**
* Returns the creation date of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getCreationDateFor($idsite)
{
return self::getFor($idsite, 'ts_created');
}
/**
* Returns the url for the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getMainUrlFor($idsite)
{
return self::getFor($idsite, 'main_url');
}
/**
* Returns whether the site with the specified ID is ecommerce enabled or not.
*
* @param int $idsite The site ID.
* @return string
*/
public static function isEcommerceEnabledFor($idsite)
{
return self::getFor($idsite, 'ecommerce') == 1;
}
/**
* Returns whether the site with the specified ID is Site Search enabled.
*
* @param int $idsite The site ID.
* @return string
*/
public static function isSiteSearchEnabledFor($idsite)
{
return self::getFor($idsite, 'sitesearch') == 1;
}
/**
* Returns the currency of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getCurrencyFor($idsite)
{
return self::getFor($idsite, 'currency');
}
/**
* Returns the currency of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getCurrencySymbolFor($idsite)
{
$currencyCode = self::getCurrencyFor($idsite);
$key = 'Intl_CurrencySymbol_' . $currencyCode;
$symbol = Piwik::translate($key);
if ($key === $symbol) {
return $currencyCode;
}
return $symbol;
}
/**
* Returns the list of all known currency symbols.
*
* @return array An array mapping currency codes to their respective currency symbols
* and a description, eg, `array('USD' => array('$', 'US dollar'))`.
*
* @deprecated Use Piwik\Intl\Data\Provider\CurrencyDataProvider instead.
* @see \Piwik\Intl\Data\Provider\CurrencyDataProvider::getCurrencyList()
* @api
*/
public static function getCurrencyList()
{
/** @var CurrencyDataProvider $dataProvider */
$dataProvider = StaticContainer::get('Piwik\Intl\Data\Provider\CurrencyDataProvider');
return $dataProvider->getCurrencyList();
}
/**
* Returns the excluded IP addresses of the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getExcludedIpsFor($idsite)
{
return self::getFor($idsite, 'excluded_ips');
}
/**
* Returns the excluded query parameters for the site with the specified ID.
*
* @param int $idsite The site ID.
* @return string
*/
public static function getExcludedQueryParametersFor($idsite)
{
return self::getFor($idsite, 'excluded_parameters');
}
/**
* Returns the user that created this site.
*
* @param int $idsite The site ID.
* @return string|null If null, the site was created before the creation user was tracked.
*/
public static function getCreatorLoginFor($idsite)
{
return self::getFor($idsite, 'creator_login');
}
}
|