Server : LiteSpeed System : Linux premium84.web-hosting.com 4.18.0-553.44.1.lve.el8.x86_64 #1 SMP Thu Mar 13 14:29:12 UTC 2025 x86_64 User : claqxcrl ( 523) PHP Version : 8.1.32 Disable Function : NONE Directory : /home/claqxcrl/anfangola.com/wp-content/plugins/matomo/app/plugins/SitesManager/ |
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\SitesManager;
use DateTimeZone;
use Exception;
use Matomo\Network\IPUtils;
use Piwik\Access;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\DataAccess\Model as CoreModel;
use Piwik\Date;
use Piwik\Exception\UnexpectedWebsiteFoundException;
use Piwik\Intl\Data\Provider\CurrencyDataProvider;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugin\SettingsProvider;
use Piwik\Plugins\CorePluginsAdmin\SettingsMetadata;
use Piwik\Plugins\SitesManager\SiteContentDetection\ConsentManagerDetectionAbstract;
use Piwik\Plugins\SitesManager\SiteContentDetection\SiteContentDetectionAbstract;
use Piwik\Plugins\WebsiteMeasurable\Settings\Urls;
use Piwik\ProxyHttp;
use Piwik\Scheduler\Scheduler;
use Piwik\Settings\Measurable\MeasurableProperty;
use Piwik\Settings\Measurable\MeasurableSettings;
use Piwik\SettingsPiwik;
use Piwik\SettingsServer;
use Piwik\Site;
use Piwik\SiteContentDetector;
use Piwik\Tracker\Cache;
use Piwik\Tracker\TrackerCodeGenerator;
use Piwik\Translation\Translator;
use Piwik\Url;
use Piwik\UrlHelper;
/**
* The SitesManager API gives you full control on Websites in Matomo (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 Matomo 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://matomo.org/docs/manage-websites/' rel='noreferrer' target='_blank'>Managing Websites</a> in Matomo.
* @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,keywords';
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_EXCLUDED_REFERRERS_GLOBAL = 'SitesManager_ExcludedReferrersGlobal';
const OPTION_KEEP_URL_FRAGMENTS_GLOBAL = 'SitesManager_KeepURLFragmentsGlobal';
/**
* @var SettingsProvider
*/
private $settingsProvider;
/**
* @var SettingsMetadata
*/
private $settingsMetadata;
/**
* @var Translator
*/
private $translator;
private $timezoneNameCache = [];
/** @var SiteContentDetector */
private $siteContentDetector;
public function __construct(SettingsProvider $provider, SettingsMetadata $settingsMetadata, Translator $translator, SiteContentDetector $siteContentDetector)
{
$this->settingsProvider = $provider;
$this->settingsMetadata = $settingsMetadata;
$this->translator = $translator;
$this->siteContentDetector = $siteContentDetector;
}
/**
* Returns the javascript tag for the given idSite.
* This tag must be included on every page to be tracked by Matomo
*
* @param int $idSite
* @param string $piwikUrl
* @param bool $mergeSubdomains
* @param bool $groupPageTitlesByDomain
* @param bool $mergeAliasUrls
* @param array $visitorCustomVariables
* @param array $pageCustomVariables
* @param string $customCampaignNameQueryParam
* @param string $customCampaignKeywordParam
* @param bool $doNotTrack
* @param bool $disableCookies
* @param bool $trackNoScript
* @param bool $crossDomain
* @param bool $forceMatomoEndpoint Whether the Matomo endpoint should be forced if Matomo was installed prior 3.7.0.
* @param string|array $excludedQueryParams array or comma separated string of excluded query parameters.
* @param string|array $excludedReferrers array or comma separated string of ignored referrers. Defaults to configured ignored referrers
*
* @return string The Javascript tag ready to be included on the HTML pages
* @throws Exception
* @unsanitized
*/
public function getJavascriptTag(int $idSite, string $piwikUrl = '', bool $mergeSubdomains = false, bool $groupPageTitlesByDomain = false, bool $mergeAliasUrls = false, array $visitorCustomVariables = [], array $pageCustomVariables = [], string $customCampaignNameQueryParam = '', string $customCampaignKeywordParam = '', bool $doNotTrack = false, bool $disableCookies = false, bool $trackNoScript = false, bool $crossDomain = false, bool $forceMatomoEndpoint = false, $excludedQueryParams = '', $excludedReferrers = '')
{
Piwik::checkUserHasViewAccess($idSite);
if (empty($piwikUrl)) {
$piwikUrl = SettingsPiwik::getPiwikUrl();
}
if (is_array($excludedQueryParams)) {
$excludedQueryParams = implode(',', $excludedQueryParams);
}
$generator = new TrackerCodeGenerator();
if ($forceMatomoEndpoint) {
$generator->forceMatomoEndpoint();
}
$code = $generator->generate($idSite, $piwikUrl, $mergeSubdomains, $groupPageTitlesByDomain, $mergeAliasUrls, $visitorCustomVariables, $pageCustomVariables, $customCampaignNameQueryParam, $customCampaignKeywordParam, $doNotTrack, $disableCookies, $trackNoScript, $crossDomain, $excludedQueryParams, $excludedReferrers);
return str_replace(['<br>', '<br />', '<br/>'], '', $code);
}
/**
* 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 Matomo 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.
* @param bool $forceMatomoEndpoint Whether the Matomo endpoint should be forced if Matomo was installed prior 3.7.0.
* @return string The HTML tracking code.
*/
public function getImageTrackingCode($idSite, $piwikUrl = '', $actionName = false, $idGoal = false, $revenue = false, $forceMatomoEndpoint = false)
{
$urlParams = ['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 Matomo installation, eg,
* `'examplepiwik.com/path/to/piwik'`.
* @param array &$urlParams The query parameters used in the <img> element's src
* URL. See Matomo's image tracking docs for more info.
*/
Piwik::postEvent('SitesManager.getImageTrackingCode', [&$piwikUrl, &$urlParams]);
$trackerCodeGenerator = new TrackerCodeGenerator();
if ($forceMatomoEndpoint) {
$trackerCodeGenerator->forceMatomoEndpoint();
}
$matomoPhp = $trackerCodeGenerator->getPhpTrackerEndpoint();
$url = (ProxyHttp::isHttps() ? "https://" : "http://") . rtrim($piwikUrl, '/') . '/' . $matomoPhp . '?' . Url::getQueryStringFromParameters($urlParams);
$html = "<!-- Matomo Image Tracker-->\n<img referrerpolicy=\"no-referrer-when-downgrade\" src=\"" . htmlspecialchars($url, ENT_COMPAT, 'UTF-8') . "\" style=\"border:0\" alt=\"\" />\n<!-- End Matomo -->";
return htmlspecialchars($html, ENT_COMPAT, 'UTF-8');
}
/**
* 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);
foreach ($sites as &$site) {
$this->enrichSite($site);
}
$sites = 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);
if ($site) {
$this->enrichSite($site);
}
Site::setSiteFromArray($idSite, $site);
return $site;
}
private function getModel()
{
return new \Piwik\Plugins\SitesManager\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 = [];
foreach ($sites as $site) {
$this->enrichSite($site);
$return[$site['idsite']] = $site;
}
$return = 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 $this->getSitesId();
} catch (Exception $e) {
// can be called before Matomo tables are created so return empty
return [];
}
}
/**
* 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
* @param false|string $pattern
* @param false|int $limit
* @param []|int[] $sitesToExclude optional array of Integer IDs of sites to exclude from the result.
* @return array for each site, an array of information (idsite, name, main_url, etc.)
*/
public function getSitesWithAdminAccess($fetchAliasUrls = false, $pattern = false, $limit = false, $sitesToExclude = [])
{
$sitesId = $this->getSitesIdWithAdminAccess();
// Remove the sites to exclude from the list of IDs.
if (is_array($sitesId) && is_array($sitesToExclude) && count($sitesToExclude)) {
$sitesId = array_diff($sitesId, $sitesToExclude);
}
if ($pattern === false) {
$sites = $this->getSitesFromIds($sitesId, $limit);
} else {
$sites = $this->getModel()->getPatternMatchSites($sitesId, $pattern, $limit);
foreach ($sites as &$site) {
$this->enrichSite($site);
}
$sites = Site::setSitesFromArray($sites);
}
if ($fetchAliasUrls) {
foreach ($sites as &$site) {
$site['alias_urls'] = $this->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 running 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 'write' access for the current user.
* For the superUser it doesn't return any result because the superUser has write access on all the websites (use getSitesIdWithAtLeastWriteAccess() instead).
*
* @return array list of websites ID
*/
public function getSitesIdWithWriteAccess()
{
return Access::getInstance()->getSitesIdWithWriteAccess();
}
/**
* 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)
{
/** @var Scheduler $scheduler */
$scheduler = StaticContainer::getContainer()->get('Piwik\\Scheduler\\Scheduler');
if (Piwik::hasUserSuperUserAccess() && !$scheduler->isRunningTask()) {
return Access::getInstance()->getSitesIdWithAtLeastViewAccess();
}
if (!empty($_restrictSitesToLogin) && (Piwik::hasUserSuperUserAccessOrIsTheUser($_restrictSitesToLogin) || $scheduler->isRunningTask())) {
if (Piwik::hasTheUserSuperUserAccess($_restrictSitesToLogin)) {
return Access::getInstance()->getSitesIdWithAtLeastViewAccess();
}
$accessRaw = Access::getInstance()->getRawSitesWithSomeViewAccess($_restrictSitesToLogin);
$sitesId = [];
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);
foreach ($sites as &$site) {
$this->enrichSite($site);
}
$sites = Site::setSitesFromArray($sites);
return $sites;
}
protected function getNormalizedUrls($url)
{
// if found, remove scheme and www. from URL
$hostname = str_replace('www.', '', $url);
$hostname = str_replace('http://', '', $hostname);
$hostname = str_replace('https://', '', $hostname);
// return all variations of the URL
return [$url, "http://" . $hostname, "http://www." . $hostname, "https://" . $hostname, "https://www." . $hostname];
}
/**
* 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);
$normalisedUrls = $this->getNormalizedUrls($url);
if (Piwik::hasUserSuperUserAccess()) {
$ids = $this->getModel()->getAllSitesIdFromSiteUrl($normalisedUrls);
} else {
$login = Piwik::getCurrentUserLogin();
$ids = $this->getModel()->getSitesIdFromSiteUrlHavingAccess($login, $normalisedUrls);
}
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 = [];
foreach ($ids as $id) {
$return[] = $id['idsite'];
}
return $return;
}
private function enrichSite(&$site)
{
$cacheKey = $site['timezone'] . $this->translator->getCurrentLanguage();
if (!isset($this->timezoneNameCache[$cacheKey])) {
//cached as this can be called VERY often and getTimezoneName is quite slow
$this->timezoneNameCache[$cacheKey] = $this->getTimezoneName($site['timezone']);
}
$site['timezone_name'] = $this->timezoneNameCache[$cacheKey];
$key = 'Intl_Currency_' . $site['currency'];
$name = $this->translator->translate($key);
$site['currency_name'] = $key === $name ? $site['currency'] : $name;
// don't want to expose other user logins here
if (!Piwik::hasUserSuperUserAccess()) {
unset($site['creator_login']);
}
}
/**
* 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.
* When calling API via HTTP specify multiple URLs via `&urls[]=http...&urls[]=http...`.
* @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.
* @param array|null $settingValues JSON serialized settings eg {settingName: settingValue, ...}
* @see getKeepURLFragmentsGlobal.
* @param string $type The website type, defaults to "website" if not set.
* @param bool|null $excludeUnknownUrls Track only URL matching one of website URLs
* @param string|null $excludedReferrers Comma separated list of hosts/urls to exclude from referrer detection
*
* @return int the website ID created
*/
public function addSite($siteName, $urls = null, $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, $settingValues = null, $excludeUnknownUrls = null, $excludedReferrers = null)
{
Piwik::checkUserHasSuperUserAccess();
\Piwik\Plugins\SitesManager\SitesManager::dieIfSitesAdminIsDisabled();
$this->checkName($siteName);
if (!isset($settingValues)) {
$settingValues = [];
}
$coreProperties = [];
$coreProperties = $this->setSettingValue('urls', $urls, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('ecommerce', $ecommerce, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('group', $group, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('sitesearch', $siteSearch, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('sitesearch_keyword_parameters', explode(',', $searchKeywordParameters ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('sitesearch_category_parameters', explode(',', $searchCategoryParameters ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('keep_url_fragment', $keepURLFragments, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('exclude_unknown_urls', $excludeUnknownUrls, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_ips', explode(',', $excludedIps ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_parameters', explode(',', $excludedQueryParameters ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_user_agents', explode(',', $excludedUserAgents ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_referrers', explode(',', $excludedReferrers ?? ''), $coreProperties, $settingValues);
$timezone = trim($timezone ?? '');
if (empty($timezone)) {
$timezone = $this->getDefaultTimezone();
}
$this->checkValidTimezone($timezone);
if (empty($currency)) {
$currency = $this->getDefaultCurrency();
}
$this->checkValidCurrency($currency);
$bind = ['name' => $siteName];
$bind['timezone'] = $timezone;
$bind['currency'] = $currency;
$bind['main_url'] = '';
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'] = "";
}
$bind['creator_login'] = Piwik::getCurrentUserLogin();
$allSettings = $this->setAndValidateMeasurableSettings(0, 'website', $coreProperties);
// any setting specified in setting values will overwrite other setting
if (!empty($settingValues)) {
$this->setAndValidateMeasurableSettings(0, $bind['type'], $settingValues);
}
foreach ($allSettings as $settings) {
foreach ($settings->getSettingsWritableByCurrentUser() as $setting) {
$name = $setting->getName();
if ($setting instanceof MeasurableProperty && $name !== 'urls') {
$default = $setting->getDefaultValue();
if (is_bool($default)) {
$default = (int) $default;
} elseif (is_array($default)) {
$default = implode(',', $default);
}
$bind[$name] = $default;
}
}
}
$idSite = $this->getModel()->createSite($bind);
if (!empty($coreProperties)) {
$this->saveMeasurableSettings($idSite, 'website', $coreProperties);
}
if (!empty($settingValues)) {
$this->saveMeasurableSettings($idSite, $bind['type'], $settingValues);
}
// 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', [$idSite]);
return (int) $idSite;
}
private function setSettingValue($fieldName, $value, $coreProperties, $settingValues)
{
$pluginName = 'WebsiteMeasurable';
if (isset($value)) {
if (empty($coreProperties[$pluginName])) {
$coreProperties[$pluginName] = [];
}
$coreProperties[$pluginName][] = ['name' => $fieldName, 'value' => $value];
} elseif (!empty($settingValues[$pluginName])) {
// we check if the value is defined in the setting values instead
foreach ($settingValues[$pluginName] as $key => $setting) {
if ($setting['name'] === $fieldName) {
if (empty($coreProperties[$pluginName])) {
$coreProperties[$pluginName] = [];
}
$coreProperties[$pluginName][] = ['name' => $fieldName, 'value' => $setting['value']];
return $coreProperties;
}
}
}
return $coreProperties;
}
public function getSiteSettings($idSite)
{
Piwik::checkUserHasAdminAccess($idSite);
$measurableSettings = $this->settingsProvider->getAllMeasurableSettings($idSite, $idMeasurableType = false);
return $this->settingsMetadata->formatSettings($measurableSettings);
}
private function setAndValidateMeasurableSettings($idSite, $idType, $settingValues)
{
$measurableSettings = $this->settingsProvider->getAllMeasurableSettings($idSite, $idType);
$this->settingsMetadata->setPluginSettings($measurableSettings, $settingValues);
return $measurableSettings;
}
/**
* @param MeasurableSettings[] $measurableSettings
*/
private function saveMeasurableSettings($idSite, $idType, $settingValues)
{
$measurableSettings = $this->setAndValidateMeasurableSettings($idSite, $idType, $settingValues);
foreach ($measurableSettings as $measurableSetting) {
$measurableSetting->save();
}
}
private function postUpdateWebsite($idSite)
{
Site::clearCache();
Cache::regenerateCacheWebsiteAttributes($idSite);
Cache::clearCacheGeneral();
\Piwik\Plugins\SitesManager\SiteUrls::clearSitesCache();
}
/**
* Delete a website from the database, given its Id. The method deletes the actual site as well as some associated
* data. However, it does not delete any logs or archives that belong to this website. You can delete logs and
* archives for a site manually as described in this FAQ: http://matomo.org/faq/how-to/faq_73/ .
*
* Requires Super User access.
*
* @param int $idSite
* @param string $passwordConfirmation the current user's password, only required when the request is authenticated with session token auth
* @throws Exception
*/
public function deleteSite($idSite, $passwordConfirmation = null)
{
Piwik::checkUserHasSuperUserAccess();
\Piwik\Plugins\SitesManager\SitesManager::dieIfSitesAdminIsDisabled();
if (Common::getRequestVar('force_api_session', 0)) {
$this->confirmCurrentUserPassword($passwordConfirmation);
}
$idSites = $this->getSitesId();
if (!in_array($idSite, $idSites)) {
throw new Exception("website id = {$idSite} not found");
}
$nbSites = count($idSites);
if ($nbSites == 1) {
throw new Exception($this->translator->translate("SitesManager_ExceptionDeleteSite"));
}
$this->getModel()->deleteSite($idSite);
$coreModel = new CoreModel();
$coreModel->deleteInvalidationsForSites([$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', [$idSite]);
}
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($this->translator->translate('SitesManager_ExceptionInvalidTimezone', [$timezone]));
}
private function checkValidCurrency($currency)
{
if (!in_array($currency, array_keys($this->getCurrencyList()))) {
throw new Exception($this->translator->translate('SitesManager_ExceptionInvalidCurrency', [$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 string Comma separated list of IP addresses
*/
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($this->translator->translate('SitesManager_ExceptionInvalidIPFormat', [$ip, "1.2.3.4, 1.2.3.*, or 1.2.3.4/5"]));
}
}
return implode(',', $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 When calling API via HTTP specify multiple URLs via `&urls[]=http...&urls[]=http...`.
* @return int the number of inserted URLs
*/
public function addSiteAliasUrls($idSite, $urls)
{
Piwik::checkUserHasAdminAccess($idSite);
if (empty($urls)) {
return 0;
}
if (!is_array($urls)) {
$urls = [$urls];
}
$urlsInit = $this->getSiteUrlsFromId($idSite);
$toInsert = array_merge($urlsInit, $urls);
$urlsProperty = new Urls($idSite);
$urlsProperty->setValue($toInsert);
$urlsProperty->save();
$inserted = array_diff($urlsProperty->getValue(), $urlsInit);
$this->postUpdateWebsite($idSite);
return count($inserted);
}
/**
* 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 = [])
{
Piwik::checkUserHasAdminAccess($idSite);
$mainUrl = Site::getMainUrlFor($idSite);
array_unshift($urls, $mainUrl);
$urlsProperty = new Urls($idSite);
$urlsProperty->setValue($urls);
$urlsProperty->save();
$inserted = array_diff($urlsProperty->getValue(), $urls);
$this->postUpdateWebsite($idSite);
return count($inserted);
}
/**
* 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 [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 the list of urls/hosts that should be ignored when detecting referrers for the given site.
*
* @return array list of urls/hosts
*/
public function getExcludedReferrers($idSite)
{
try {
$attributes = Cache::getCacheWebsiteAttributes($idSite);
if (isset($attributes['excluded_referrers'])) {
return $attributes['excluded_referrers'];
}
} catch (UnexpectedWebsiteFoundException $e) {
$cached = Cache::getCacheGeneral();
if (isset($cached['global_excluded_referrers'])) {
return $cached['global_excluded_referrers'];
}
}
return [];
}
/**
* Returns the global list of urls/hosts that should be ignored when detecting referrers.
* If a visitor is coming from a site on this list, it will be treated as direct entry
*
* @return string Comma separated list of strings
*/
public function getExcludedReferrersGlobal() : string
{
Piwik::checkUserHasSomeAdminAccess();
$exclusion = Option::get(self::OPTION_EXCLUDED_REFERRERS_GLOBAL);
return is_string($exclusion) ? $exclusion : '';
}
/**
* Sets list of urls/hosts that should be ignored when detecting referrers. For more info,
* @see getExcludedReferrersGlobal.
*
* @param string $excludedReferrers Comma separated list of strings. Each element is trimmed,
* and empty strings are removed.
*/
public function setGlobalExcludedReferrers(string $excludedReferrers) : void
{
Piwik::checkUserHasSuperUserAccess();
$excludedUrls = $this->checkAndReturnCommaSeparatedStringList($excludedReferrers);
foreach (!empty($excludedUrls) ? explode(',', $excludedUrls) : [] as $url) {
// We allow urls to be provided:
// - fully qualified like http://example.url/path
// - without protocol like example.url/path
// - with subdomain wildcard like .example.url/path
$prefixedUrl = 'https://' . ltrim(preg_replace('/^https?:\\/\\//', '', $url), '.');
$parsedUrl = @parse_url($prefixedUrl);
if (false === $parsedUrl || !UrlHelper::isLookLikeUrl($prefixedUrl)) {
throw new Exception(Piwik::translate('SitesManager_ExceptionInvalidUrl', [$url]));
}
}
// update option
Option::set(self::OPTION_EXCLUDED_REFERRERS_GLOBAL, $excludedUrls);
// 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;
}
/**
* Update an existing website.
* If only one URL is specified then only the main url will be updated.
* If several URLs are specified, both the main URL and the alias URLs will be updated.
*
* @param int $idSite website ID defining the website to edit
* @param string $siteName website name
* @param string|array $urls the website URLs
* When calling API via HTTP specify multiple URLs via `&urls[]=http...&urls[]=http...`.
* @param int $ecommerce Whether Ecommerce is enabled, 0 or 1
* @param null|int $siteSearch Whether site search is enabled, 0 or 1
* @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 being tracked (allows wildcards)
* @param null|string $excludedQueryParameters
* @param string $timezone Timezone
* @param string $currency Currency code
* @param string $group Group name where this website belongs
* @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|null $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.
* @param string $type The Website type, default value is "website"
* @param array|null $settingValues JSON serialized settings eg {settingName: settingValue, ...}
* @param bool|null $excludeUnknownUrls Track only URL matching one of website URLs
* @param string|null $excludedReferrers Comma separated list of hosts/urls to exclude from referrer detection
* @throws Exception
* @see getKeepURLFragmentsGlobal. If null, the existing value will
* not be modified.
*
* @return bool true on success
*/
public function updateSite($idSite, $siteName = null, $urls = null, $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, $settingValues = null, $excludeUnknownUrls = null, $excludedReferrers = null)
{
Piwik::checkUserHasAdminAccess($idSite);
\Piwik\Plugins\SitesManager\SitesManager::dieIfSitesAdminIsDisabled();
$idSites = $this->getSitesId();
if (!in_array($idSite, $idSites)) {
throw new Exception("website id = {$idSite} not found");
}
// Build the SQL UPDATE based on specified updates to perform
$bind = [];
if (!is_null($siteName)) {
$this->checkName($siteName);
$bind['name'] = $siteName;
}
if (!isset($settingValues)) {
$settingValues = [];
}
if (empty($coreProperties)) {
$coreProperties = [];
}
$coreProperties = $this->setSettingValue('urls', $urls, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('group', $group, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('ecommerce', $ecommerce, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('sitesearch', $siteSearch, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('sitesearch_keyword_parameters', explode(',', $searchKeywordParameters ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('sitesearch_category_parameters', explode(',', $searchCategoryParameters ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('keep_url_fragment', $keepURLFragments, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('exclude_unknown_urls', $excludeUnknownUrls, $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_ips', explode(',', $excludedIps ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_parameters', explode(',', $excludedQueryParameters ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_user_agents', explode(',', $excludedUserAgents ?? ''), $coreProperties, $settingValues);
$coreProperties = $this->setSettingValue('excluded_referrers', explode(',', $excludedReferrers ?? ''), $coreProperties, $settingValues);
if (isset($currency)) {
$currency = trim($currency);
$this->checkValidCurrency($currency);
$bind['currency'] = $currency;
}
if (isset($timezone)) {
$timezone = trim($timezone);
$this->checkValidTimezone($timezone);
$bind['timezone'] = $timezone;
}
if (isset($group) && Piwik::hasUserSuperUserAccess()) {
$bind['group'] = trim($group);
}
if (isset($startDate)) {
$bind['ts_created'] = Date::factory($startDate)->getDatetime();
}
if (isset($type)) {
$bind['type'] = $this->checkAndReturnType($type);
}
if (!empty($coreProperties)) {
$this->setAndValidateMeasurableSettings($idSite, $idType = 'website', $coreProperties);
}
if (!empty($settingValues)) {
$this->setAndValidateMeasurableSettings($idSite, $idType = null, $settingValues);
}
if (!empty($bind)) {
$this->getModel()->updateSite($bind, $idSite);
}
if (!empty($coreProperties)) {
$this->saveMeasurableSettings($idSite, $idType = 'website', $coreProperties);
}
if (!empty($settingValues)) {
$this->saveMeasurableSettings($idSite, $idType = null, $settingValues);
}
$this->postUpdateWebsite($idSite);
}
/**
* Updates the field ts_created for the specified websites.
*
* @param $idSites int Id Site to update ts_created
* @param $minDate Date to set as creation date. To play it safe it will subtract one more day.
*
* @ignore
*/
public function updateSiteCreatedTime($idSites, Date $minDate)
{
$idSites = Site::getIdSitesFromIdSitesString($idSites);
Piwik::checkUserHasAdminAccess($idSites);
$minDateSql = $minDate->subDay(1)->getDatetime();
$this->getModel()->updateSiteCreatedTime($idSites, $minDateSql);
}
private function checkAndReturnCommaSeparatedStringList($parameters)
{
$parameters = trim($parameters);
if (empty($parameters)) {
return '';
}
$parameters = explode(',', $parameters);
$parameters = array_map('trim', $parameters);
$parameters = array_filter($parameters, 'strlen');
$parameters = array_unique($parameters);
return implode(',', $parameters);
}
/**
* Returns the list of supported currencies
* @see getCurrencySymbols()
* @return array ( currencyId => currencyName)
*/
public function getCurrencyList()
{
/** @var CurrencyDataProvider $dataProvider */
$dataProvider = StaticContainer::get('Piwik\\Intl\\Data\\Provider\\CurrencyDataProvider');
$currency = $dataProvider->getCurrencyList();
$return = [];
foreach (array_keys($currency) as $currencyCode) {
$return[$currencyCode] = $this->translator->translate('Intl_Currency_' . $currencyCode) . ' (' . $this->translator->translate('Intl_CurrencySymbol_' . $currencyCode) . ')';
}
asort($return);
return $return;
}
/**
* Returns the list of currency symbols
* @see getCurrencyList()
* @return array( currencyId => currencySymbol )
*/
public function getCurrencySymbols()
{
/** @var CurrencyDataProvider $dataProvider */
$dataProvider = StaticContainer::get('Piwik\\Intl\\Data\\Provider\\CurrencyDataProvider');
$currencies = $dataProvider->getCurrencyList();
return array_map(function ($a) {
return $a[0];
}, $currencies);
}
/**
* Return true if Timezone support is enabled on server
*
* @return bool
*/
public function isTimezoneSupportEnabled()
{
Piwik::checkUserHasSomeViewAccess();
return SettingsServer::isTimezoneSupportEnabled();
}
/**
* Returns the list of timezones supported.
* Used for addSite and updateSite
*
* @return array of timezone strings
*/
public function getTimezonesList()
{
if (!SettingsServer::isTimezoneSupportEnabled()) {
return ['UTC' => $this->getTimezonesListUTCOffsets()];
}
$countries = StaticContainer::get('Piwik\\Intl\\Data\\Provider\\RegionDataProvider')->getCountryList();
$return = [];
$continents = [];
foreach ($countries as $countryCode => $continentCode) {
$countryCode = strtoupper($countryCode);
$timezones = DateTimeZone::listIdentifiers(DateTimeZone::PER_COUNTRY, $countryCode);
foreach ($timezones as $timezone) {
if (!isset($continents[$continentCode])) {
$continents[$continentCode] = $this->translator->translate('Intl_Continent_' . $continentCode);
}
$continent = $continents[$continentCode];
$return[$continent][$timezone] = $this->getTimezoneName($timezone, $countryCode, count($timezones) > 1);
}
}
// Sort by continent name and then by country name.
ksort($return);
foreach ($return as $continent => $countries) {
asort($return[$continent]);
}
$return['UTC'] = $this->getTimezonesListUTCOffsets();
return $return;
}
/**
* Returns a user-friendly label for a timezone.
* This is usually the country name of the timezone. For countries spanning multiple timezones,
* a city/location name is added to avoid ambiguity.
*
* @param string $timezone a timezone, e.g. "Asia/Tokyo" or "America/Los_Angeles"
* @param string $countryCode an upper-case country code (if not supplied, it will be looked up)
* @param bool $multipleTimezonesInCountry whether there are multiple timezones in the country (if not supplied, it will be looked up)
* @return string a timezone label, e.g. "Japan" or "United States - Los Angeles"
*/
public function getTimezoneName($timezone, $countryCode = null, $multipleTimezonesInCountry = null)
{
if (substr($timezone, 0, 3) === 'UTC') {
return $this->translator->translate('SitesManager_Format_Utc', str_replace(['.25', '.5', '.75'], [':15', ':30', ':45'], substr($timezone, 3)));
}
if (!isset($countryCode)) {
try {
$zone = new DateTimeZone($timezone);
$location = $zone->getLocation();
if (isset($location['country_code']) && $location['country_code'] !== '??') {
$countryCode = $location['country_code'];
}
} catch (Exception $e) {
}
}
if (!$countryCode) {
$timezoneExploded = explode('/', $timezone);
return str_replace('_', ' ', end($timezoneExploded));
}
if (!isset($multipleTimezonesInCountry)) {
$timezonesInCountry = DateTimeZone::listIdentifiers(DateTimeZone::PER_COUNTRY, $countryCode);
$multipleTimezonesInCountry = count($timezonesInCountry) > 1;
}
$return = $this->translator->translate('Intl_Country_' . $countryCode);
if ($multipleTimezonesInCountry) {
$translationId = 'Intl_Timezone_' . str_replace(['_', '/'], ['', '_'], $timezone);
$city = $this->translator->translate($translationId);
// Fall back to English identifier, if translation is missing due to differences in tzdata in different PHP versions.
if ($city === $translationId) {
$timezoneExploded = explode('/', $timezone);
$city = str_replace('_', ' ', end($timezoneExploded));
}
$return .= ' - ' . $city;
}
return $return;
}
private function getTimezonesListUTCOffsets()
{
// manually add the UTC offsets
$GmtOffsets = [-12, -11.5, -11, -10.5, -10, -9.5, -9, -8.5, -8, -7.5, -7, -6.5, -6, -5.5, -5, -4.5, -4, -3.5, -3, -2.5, -2, -1.5, -1, -0.5, 0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 5.75, 6, 6.5, 7, 7.5, 8, 8.5, 8.75, 9, 9.5, 10, 10.5, 11, 11.5, 12, 12.75, 13, 13.75, 14];
$return = [];
foreach ($GmtOffsets as $offset) {
$offset = Common::forceDotAsSeparatorForDecimalPoint($offset);
if ($offset > 0) {
$offset = '+' . $offset;
} elseif ($offset == 0) {
$offset = '';
}
$timezone = 'UTC' . $offset;
$return[$timezone] = $this->getTimezoneName($timezone);
}
return $return;
}
/**
* Returns the list of unique timezones from all configured sites.
*
* @return array ( string )
*/
public function getUniqueSiteTimezones()
{
Piwik::checkUserHasSuperUserAccess();
return $this->getModel()->getUniqueSiteTimezones();
}
/**
* Remove the final slash in the URLs if found
*
* @param string $url
* @return string the URL without the trailing slash
*/
private function removeTrailingSlash($url)
{
// if there is a final slash, we take the URL without this slash (expected URL format)
if (strlen($url) > 5 && $url[strlen($url) - 1] == '/') {
$url = substr($url, 0, strlen($url) - 1);
}
return $url;
}
/**
* Tests if the URL is a valid URL
*
* @param string $url
* @return bool
*/
private function isValidUrl($url)
{
return UrlHelper::isLookLikeUrl($url);
}
/**
* Tests if the IP is a valid IP, allowing wildcards, except in the first octet.
* Wildcards can only be used from right to left, ie. 1.1.*.* is allowed, but 1.1.*.1 is not.
*
* @param string $ip IP address
* @return bool
*/
private function isValidIp($ip)
{
return IPUtils::getIPRangeBounds($ip) !== null;
}
/**
* Check that the website name has a correct format.
*
* @param $siteName
* @throws Exception
*/
private function checkName($siteName)
{
if (empty($siteName)) {
throw new Exception($this->translator->translate("SitesManager_ExceptionEmptyName"));
}
}
public function renameGroup($oldGroupName, $newGroupName)
{
Piwik::checkUserHasSuperUserAccess();
if ($oldGroupName == $newGroupName) {
return true;
}
$sitesHavingOldGroup = $this->getSitesFromGroup($oldGroupName);
foreach ($sitesHavingOldGroup as $site) {
$this->updateSite($site['idsite'], $siteName = null, $urls = null, $ecommerce = null, $siteSearch = null, $searchKeywordParameters = null, $searchCategoryParameters = null, $excludedIps = null, $excludedQueryParameters = null, $timezone = null, $currency = null, $newGroupName);
}
return true;
}
/**
* Find websites matching the given pattern.
*
* Any website will be returned that matches the pattern in the name, URL or group.
* To limit the number of returned sites you can either specify `filter_limit` as usual or `limit` which is
* faster.
*
* @param string $pattern
* @param int|false $limit
* @param []|int[] $sitesToExclude optional array of Integer IDs of sites to exclude from the result.
* @return array
*/
public function getPatternMatchSites($pattern, $limit = false, $sitesToExclude = [])
{
$ids = $this->getSitesIdWithAtLeastViewAccess();
// Remove the sites to exclude from the list of IDs.
if (is_array($ids) && is_array($sitesToExclude) && count($sitesToExclude)) {
$ids = array_diff($ids, $sitesToExclude);
}
if (empty($ids)) {
return [];
}
$sites = $this->getModel()->getPatternMatchSites($ids, $pattern, $limit);
foreach ($sites as &$site) {
$this->enrichSite($site);
}
$sites = Site::setSitesFromArray($sites);
return $sites;
}
/**
* Returns the number of websites to display per page.
*
* For example this is used in the All Websites Dashboard, in the Website Selector etc. If multiple websites are
* shown somewhere, one should request this method to detect how many websites should be shown per page when
* using paging. To use paging is always recommended since some installations have thousands of websites.
*
* @return int
*/
public function getNumWebsitesToDisplayPerPage()
{
Piwik::checkUserHasSomeViewAccess();
return SettingsPiwik::getWebsitesCountToDisplay();
}
/**
* Detect consent manager details for a site
*
* @internal
* @unsanitized
*/
public function detectConsentManager(int $idSite, int $timeOut = 60) : ?array
{
Piwik::checkUserHasViewAccess($idSite);
$this->siteContentDetector->detectContent([SiteContentDetectionAbstract::TYPE_CONSENT_MANAGER], $idSite, null, $timeOut);
$consentManagers = $this->siteContentDetector->getDetectsByType(SiteContentDetectionAbstract::TYPE_CONSENT_MANAGER);
if (!empty($consentManagers)) {
/** @var ConsentManagerDetectionAbstract $consentManager */
$consentManager = $this->siteContentDetector->getSiteContentDetectionById(reset($consentManagers));
return ['name' => $consentManager::getName(), 'url' => $consentManager::getInstructionUrl(), 'isConnected' => in_array($consentManager::getId(), $this->siteContentDetector->connectedConsentManagers)];
}
return null;
}
}