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/Referrers/ |
<?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\Referrers;
use Exception;
use Piwik\API\Request;
use Piwik\API\ResponseBuilder;
use Piwik\Archive;
use Piwik\Common;
use Piwik\DataTable;
use Piwik\Date;
use Piwik\Metrics;
use Piwik\Piwik;
use Piwik\Plugins\Referrers\Columns\Metrics\VisitorsFromReferrerPercent;
use Piwik\Plugins\Referrers\DataTable\Filter\GroupDifferentSocialWritings;
use Piwik\Site;
/**
* The Referrers API lets you access reports about Websites, Search engines, Keywords, Campaigns used to access your website.
*
* For example, "getKeywords" returns all search engine keywords (with <a href='https://developer.matomo.org/api-reference/reporting-api#api-response-metric-definitions' rel='noreferrer' target='_blank'>general analytics metrics</a> for each keyword), "getWebsites" returns referrer websites (along with the full Referrer URL if the parameter &expanded=1 is set).
* "getReferrerType" returns the Referrer overview report. "getCampaigns" returns the list of all campaigns (and all campaign keywords if the parameter &expanded=1 is set).
*
* @method static \Piwik\Plugins\Referrers\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
public function get($idSite, $period, $date, $segment = false, $columns = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTableReferrersType = $this->getReferrerType($idSite, $period, $date, $segment);
$dataTable = $this->createReferrerTypeTable($dataTableReferrersType);
$archive = Archive::build($idSite, $period, $date, $segment);
$numericArchives = $archive->getDataTableFromNumeric([\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME, \Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_SOCIAL_NETWORK_RECORD_NAME, \Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_KEYWORD_RECORD_NAME, \Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_WEBSITE_RECORD_NAME, \Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_URLS_RECORD_NAME, \Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME]);
$this->mergeNumericArchives($dataTable, $numericArchives);
$totalVisits = array_sum($dataTableReferrersType->getColumn(Metrics::INDEX_NB_VISITS));
$dataTable->filter(function (DataTable $table) use($totalVisits) {
$processedMetrics = $table->getMetadata(DataTable::EXTRA_PROCESSED_METRICS_METADATA_NAME) ?: [];
$percentColumns = ['Referrers_visitorsFromDirectEntry', 'Referrers_visitorsFromSearchEngines', 'Referrers_visitorsFromCampaigns', 'Referrers_visitorsFromSocialNetworks', 'Referrers_visitorsFromWebsites'];
foreach ($percentColumns as $column) {
$processedMetrics[] = new VisitorsFromReferrerPercent($column . '_percent', $column, $totalVisits);
}
$table->setMetadata(DataTable::EXTRA_PROCESSED_METRICS_METADATA_NAME, $processedMetrics);
});
if (!empty($requestedColumns)) {
$requestedColumns = Piwik::getArrayFromApiParameter($columns);
$dataTable->filter(DataTable\Filter\ColumnDelete::class, [[], $requestedColumns]);
}
return $dataTable;
}
/**
* @param string $name
* @param int $idSite
* @param string $period
* @param string|Date $date
* @param string $segment
* @param bool $expanded
* @param int|null $idSubtable
* @return DataTable
*/
protected function getDataTable($name, $idSite, $period, $date, $segment, $expanded = false, $idSubtable = null)
{
$dataTable = Archive::createDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $flat = false, $idSubtable);
return $dataTable;
}
/**
* Returns a report describing visit information for each possible referrer type. The
* result is a datatable whose subtables are the reports for each parent row's referrer type.
*
* The subtable reports are: 'getKeywords' (for search engine referrer type), 'getWebsites',
* and 'getCampaigns'.
*
* @param string $idSite The site ID.
* @param string $period The period to get data for, either 'day', 'week', 'month', 'year',
* or 'range'.
* @param string $date The date of the period.
* @param bool|string $segment The segment to use.
* @param bool|int $typeReferrer (deprecated) If you want to get data only for a specific referrer
* type, supply a type for this parameter.
* @param bool|int $idSubtable For this report this value is a referrer type ID and not an actual
* subtable ID. The result when using this parameter will be the
* specific report for the given referrer type.
* @param bool $expanded Whether to get report w/ subtables loaded or not.
* @return DataTable
*/
public function getReferrerType($idSite, $period, $date, $segment = false, $typeReferrer = false, $idSubtable = false, $expanded = false, $_setReferrerTypeLabel = true)
{
Piwik::checkUserHasViewAccess($idSite);
$this->checkSingleSite($idSite, 'getReferrerType');
// if idSubtable is supplied, interpret idSubtable as referrer type and return correct report
if ($idSubtable !== false) {
$result = false;
switch ($idSubtable) {
case Common::REFERRER_TYPE_SEARCH_ENGINE:
$result = $this->getKeywords($idSite, $period, $date, $segment);
break;
case Common::REFERRER_TYPE_SOCIAL_NETWORK:
$result = $this->getSocials($idSite, $period, $date, $segment);
break;
case Common::REFERRER_TYPE_WEBSITE:
$result = $this->getWebsites($idSite, $period, $date, $segment);
break;
case Common::REFERRER_TYPE_CAMPAIGN:
$result = $this->getCampaigns($idSite, $period, $date, $segment);
break;
default:
// invalid idSubtable, return whole report
break;
}
if ($result) {
return $this->removeSubtableIds($result);
// this report won't return subtables of individual reports
}
}
// get visits by referrer type
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::REFERRER_TYPE_RECORD_NAME, $idSite, $period, $date, $segment);
// checks for && $typeReferrer !== 'false' && $typeReferrer !== '0' added to cover intention when
// it is passed as a string in a GET or POST parameter
if ($typeReferrer !== false && $typeReferrer !== 'false' && $typeReferrer !== '0') {
// filter for a specific referrer type
$dataTable->filter('Pattern', array('label', $typeReferrer));
}
// set subtable IDs for each row to the label (which holds the int referrer type)
$dataTable->filter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\SetGetReferrerTypeSubtables', array($idSite, $period, $date, $segment, $expanded));
$dataTable->filter('AddSegmentByLabelMapping', array('referrerType', array(Common::REFERRER_TYPE_DIRECT_ENTRY => 'direct', Common::REFERRER_TYPE_CAMPAIGN => 'campaign', Common::REFERRER_TYPE_SEARCH_ENGINE => 'search', Common::REFERRER_TYPE_SOCIAL_NETWORK => 'social', Common::REFERRER_TYPE_WEBSITE => 'website')));
// set referrer type column to readable value
if ($_setReferrerTypeLabel == 1) {
$dataTable->filter(DataTable\Filter\ColumnCallbackAddMetadata::class, ['label', 'referrer_type']);
$dataTable->filter('ColumnCallbackReplace', array('label', __NAMESPACE__ . '\\getReferrerTypeLabel'));
}
return $dataTable;
}
private function checkSingleSite($idSite, $method)
{
$idSites = Site::getIdSitesFromIdSitesString($idSite);
if (count($idSites) > 1 || 'all' === $idSite) {
throw new Exception("Referrers.{$method} with multiple sites is not supported (yet).");
}
}
/**
* Returns a report that shows
*/
public function getAll($idSite, $period, $date, $segment = false)
{
Piwik::checkUserHasViewAccess($idSite);
$this->checkSingleSite($idSite, 'getAll');
$dataTable = Request::processRequest('Referrers.getReferrerType', ['idSite' => $idSite, 'period' => $period, 'date' => $date, 'segment' => $segment, 'expanded' => true, 'disable_generic_filters' => true, 'disable_queued_filters' => true, '_setReferrerTypeLabel' => 0], []);
if ($dataTable instanceof DataTable\Map) {
throw new Exception("Referrers.getAll with multiple sites or dates is not supported (yet).");
}
$dataTable = $dataTable->mergeSubtables($labelColumn = 'referer_type', $useMetadataColumn = true);
$dataTable->queueFilter('ReplaceColumnNames');
$dataTable->queueFilter('ReplaceSummaryRowLabel');
return $dataTable;
}
public function getKeywords($idSite, $period, $date, $segment = false, $expanded = false, $flat = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = Archive::createDataTableFromArchive(\Piwik\Plugins\Referrers\Archiver::KEYWORDS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $flat);
if ($flat) {
$dataTable->filterSubtables('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\SearchEnginesFromKeywordId', array($dataTable));
} else {
$dataTable->filter('AddSegmentByLabel', ['referrerKeyword', '', $allowEmptyValue = true]);
$dataTable->queueFilter('PrependSegment', array('referrerType==search;'));
}
$dataTable->queueFilter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\KeywordNotDefined');
return $dataTable;
}
const LABEL_KEYWORD_NOT_DEFINED = "";
/**
* @ignore
*/
public static function getKeywordNotDefinedString()
{
return Piwik::translate('General_NotDefined', Piwik::translate('General_ColumnKeyword'));
}
/**
* @ignore
*/
public static function getCleanKeyword($label)
{
return $label == self::LABEL_KEYWORD_NOT_DEFINED ? self::getKeywordNotDefinedString() : $label;
}
/**
* @param DataTable $table
*/
private function filterOutKeywordNotDefined($table)
{
if ($table instanceof DataTable) {
$row = $table->getRowIdFromLabel('');
if ($row) {
$table->deleteRow($row);
}
}
}
protected function getLabelsFromTable($table)
{
$request = $_GET;
$request['serialize'] = 0;
// Apply generic filters
$response = new ResponseBuilder($format = 'original', $request);
$table = $response->getResponse($table);
// If period=lastX we only keep the first resultset as we want to return a plain list
if ($table instanceof DataTable\Map) {
$tables = $table->getDataTables();
$table = current($tables);
}
// Keep the response simple, only include keywords
$keywords = $table->getColumn('label');
return $keywords;
}
public function getSearchEnginesFromKeywordId($idSite, $period, $date, $idSubtable, $segment = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::KEYWORDS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
$keywords = $this->getKeywords($idSite, $period, $date, $segment);
$keyword = $keywords->getRowFromIdSubDataTable($idSubtable)->getColumn('label');
$dataTable->filter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\SearchEnginesFromKeywordId', array($keywords, $idSubtable));
$dataTable->filter('AddSegmentByLabel', array('referrerName'));
$dataTable->queueFilter('PrependSegment', array('referrerKeyword==' . $keyword . ';referrerType==search;'));
return $dataTable;
}
public function getSearchEngines($idSite, $period, $date, $segment = false, $expanded = false, $flat = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = Archive::createDataTableFromArchive(\Piwik\Plugins\Referrers\Archiver::SEARCH_ENGINES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $flat);
if ($flat) {
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'url', function ($url) {
return \Piwik\Plugins\Referrers\SearchEngine::getInstance()->getUrlFromName($url);
}));
$dataTable->filter('MetadataCallbackAddMetadata', array('url', 'logo', function ($url) {
return \Piwik\Plugins\Referrers\SearchEngine::getInstance()->getLogoFromUrl($url);
}));
$dataTable->filterSubtables('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\KeywordsFromSearchEngineId', array($dataTable));
} else {
$dataTable->filter('AddSegmentByLabel', array('referrerName'));
$dataTable->queueFilter('PrependSegment', array('referrerType==search;'));
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', function ($url) {
return \Piwik\Plugins\Referrers\SearchEngine::getInstance()->getUrlFromName($url);
}));
$dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', function ($url) {
return \Piwik\Plugins\Referrers\SearchEngine::getInstance()->getLogoFromUrl($url);
}));
}
return $dataTable;
}
public function getKeywordsFromSearchEngineId($idSite, $period, $date, $idSubtable, $segment = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::SEARCH_ENGINES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
// get the search engine and create the URL to the search result page
$searchEngines = $this->getSearchEngines($idSite, $period, $date, $segment);
$searchEngines->applyQueuedFilters();
$row = $searchEngines->getRowFromIdSubDataTable($idSubtable);
$dataTable->filter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\KeywordsFromSearchEngineId', array($searchEngines, $idSubtable));
$dataTable->filter('AddSegmentByLabel', ['referrerKeyword']);
if (!empty($row)) {
$searchEngine = $row->getColumn('label');
$dataTable->queueFilter('PrependSegment', ['referrerName==' . $searchEngine . ';referrerType==search;']);
}
return $dataTable;
}
public function getCampaigns($idSite, $period, $date, $segment = false, $expanded = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::CAMPAIGNS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded);
$dataTable->filter('AddSegmentByLabel', array('referrerName'));
$dataTable->queueFilter('PrependSegment', array('referrerType==campaign;'));
return $dataTable;
}
public function getKeywordsFromCampaignId($idSite, $period, $date, $idSubtable, $segment = false)
{
Piwik::checkUserHasViewAccess($idSite);
$campaigns = $this->getCampaigns($idSite, $period, $date, $segment);
$campaigns->applyQueuedFilters();
$row = $campaigns->getRowFromIdSubDataTable($idSubtable);
$campaign = $row ? $row->getColumn('label') : '';
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::CAMPAIGNS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
$dataTable->filter('AddSegmentByLabel', array('referrerKeyword'));
$dataTable->queueFilter('PrependSegment', array('referrerName==' . $campaign . ';referrerType==campaign;'));
return $dataTable;
}
public function getWebsites($idSite, $period, $date, $segment = false, $expanded = false, $flat = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = Archive::createDataTableFromArchive(\Piwik\Plugins\Referrers\Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $flat, $idSubtable = null);
if ($flat) {
$dataTable->filterSubtables('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\UrlsFromWebsiteId');
} else {
$dataTable->filter('AddSegmentByLabel', array('referrerName'));
}
return $dataTable;
}
public function getUrlsFromWebsiteId($idSite, $period, $date, $idSubtable, $segment = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
$dataTable->filter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\UrlsFromWebsiteId');
$dataTable->filter('MetadataCallbackAddMetadata', array('url', 'segment', function ($url) {
return 'referrerUrl==' . urlencode($url);
}));
return $dataTable;
}
/**
* Returns report comparing the number of visits (and other info) for social network referrers.
* This is a view of the getWebsites report.
*
* @param string $idSite
* @param string $period
* @param string $date
* @param string|bool $segment
* @param bool $expanded
* @param bool $flat
* @return DataTable
*/
public function getSocials($idSite, $period, $date, $segment = false, $expanded = false, $flat = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = Archive::createDataTableFromArchive(\Piwik\Plugins\Referrers\Archiver::SOCIAL_NETWORKS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $flat);
$dataTable->filter(GroupDifferentSocialWritings::class);
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'url', function ($name) {
return \Piwik\Plugins\Referrers\Social::getInstance()->getMainUrlFromName($name);
}));
$dataTable = $this->completeSocialTablesWithOldReports($dataTable, $idSite, $period, $date, $segment, $expanded, $flat);
$dataTable->filter('MetadataCallbackAddMetadata', array('url', 'logo', function ($url) {
return \Piwik\Plugins\Referrers\Social::getInstance()->getLogoFromUrl($url);
}));
$dataTable->filter('AddSegmentByLabel', array('referrerName'));
$dataTable->queueFilter('PrependSegment', array('referrerType==social;'));
return $dataTable;
}
private function completeSocialTablesWithOldReports($dataTable, $idSite, $period, $date, $segment, $expanded, $flat)
{
return $this->combineDataTables($dataTable, function () use($idSite, $period, $date, $segment, $expanded, $flat) {
$dataTableFiltered = Archive::createDataTableFromArchive(\Piwik\Plugins\Referrers\Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, false);
$this->filterWebsitesForSocials($dataTableFiltered, $idSite, $period, $date, $segment, $expanded, $flat);
return $dataTableFiltered;
});
}
protected function combineDataTables($dataTable, $callbackForAdditionalData)
{
$isMap = false;
$hasEmptyTable = false;
if ($dataTable instanceof DataTable\Map) {
$isMap = true;
$dataTables = $dataTable->getDataTables();
} else {
$dataTables = [$dataTable];
}
foreach ($dataTables as $table) {
if ($table instanceof DataTable && !$table->getRowsCountWithoutSummaryRow()) {
$hasEmptyTable = true;
break;
}
}
if ($hasEmptyTable) {
$dataTablesForCompletion = $callbackForAdditionalData();
if (!$isMap) {
$dataTable = $dataTablesForCompletion;
} else {
$filteredTables = $dataTablesForCompletion->getDataTables();
foreach ($dataTable as $label => $table) {
if ($table instanceof DataTable && !$table->getRowsCountWithoutSummaryRow() && !empty($filteredTables[$label])) {
$dataTable->addTable($filteredTables[$label], $label);
}
}
}
}
return $dataTable;
}
/**
* @param DataTable $dataTable
*/
protected function filterWebsitesForSocials($dataTable, $idSite, $period, $date, $segment, $expanded, $flat)
{
$dataTable->filter('ColumnCallbackDeleteRow', array('label', function ($url) {
return !\Piwik\Plugins\Referrers\Social::getInstance()->isSocialUrl($url);
}));
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'url', function ($url) {
return \Piwik\Plugins\Referrers\Social::getInstance()->getMainUrl($url);
}));
$dataTable->filter('GroupBy', array('label', function ($url) {
return \Piwik\Plugins\Referrers\Social::getInstance()->getSocialNetworkFromDomain($url);
}));
$this->setSocialIdSubtables($dataTable);
$this->removeSubtableMetadata($dataTable);
if ($flat) {
$this->buildExpandedTableForFlattenGetSocials($idSite, $period, $date, $segment, $expanded, $dataTable);
}
}
/**
* Returns report containing individual referrer URLs for a specific social networking
* site.
*
* @param string $idSite
* @param string $period
* @param string $date
* @param bool|string $segment
* @param bool|int $idSubtable This ID does not reference a real DataTable record. Instead, it
* is the array index of an item in the Socials list file.
* The urls are filtered by the social network at this index.
* If false, no filtering is done and every social URL is returned.
* @return DataTable
*/
public function getUrlsForSocial($idSite, $period, $date, $segment = false, $idSubtable = false)
{
Piwik::checkUserHasViewAccess($idSite);
$dataTable = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::SOCIAL_NETWORKS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = true, $idSubtable);
if (!$idSubtable) {
$dataTable = $dataTable->mergeSubtables();
}
$dataTable = $this->combineDataTables($dataTable, function () use($idSite, $period, $date, $segment, $idSubtable) {
$dataTableFiltered = $this->getDataTable(\Piwik\Plugins\Referrers\Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = true);
$socialNetworks = array_values(\Piwik\Plugins\Referrers\Social::getInstance()->getDefinitions());
$social = isset($socialNetworks[$idSubtable - 1]) ? $socialNetworks[$idSubtable - 1] : false;
// filter out everything but social network indicated by $idSubtable
$dataTableFiltered->filter('ColumnCallbackDeleteRow', array('label', function ($url) use($social) {
return !\Piwik\Plugins\Referrers\Social::getInstance()->isSocialUrl($url, $social);
}));
return $dataTableFiltered->mergeSubtables();
});
$dataTable->filter('AddSegmentByLabel', array('referrerUrl'));
$dataTable->filter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\UrlsForSocial', array(true));
$dataTable->queueFilter('ReplaceColumnNames');
return $dataTable;
}
public function getNumberOfDistinctSearchEngines($idSite, $period, $date, $segment = false)
{
return $this->getNumeric(\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment);
}
public function getNumberOfDistinctSocialNetworks($idSite, $period, $date, $segment = false)
{
return $this->getNumeric(\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_SOCIAL_NETWORK_RECORD_NAME, $idSite, $period, $date, $segment);
}
public function getNumberOfDistinctKeywords($idSite, $period, $date, $segment = false)
{
return $this->getNumeric(\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment);
}
public function getNumberOfDistinctCampaigns($idSite, $period, $date, $segment = false)
{
return $this->getNumeric(\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment);
}
public function getNumberOfDistinctWebsites($idSite, $period, $date, $segment = false)
{
return $this->getNumeric(\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment);
}
public function getNumberOfDistinctWebsitesUrls($idSite, $period, $date, $segment = false)
{
return $this->getNumeric(\Piwik\Plugins\Referrers\Archiver::METRIC_DISTINCT_URLS_RECORD_NAME, $idSite, $period, $date, $segment);
}
private function getNumeric($name, $idSite, $period, $date, $segment)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Archive::build($idSite, $period, $date, $segment);
return $archive->getDataTableFromNumeric($name);
}
/**
* Removes idsubdatatable_in_db metadata from a DataTable. Used by Social tables since
* they use fake subtable IDs.
*
* @param DataTable $dataTable
*/
private function removeSubtableMetadata($dataTable)
{
if ($dataTable instanceof DataTable\Map) {
foreach ($dataTable->getDataTables() as $childTable) {
$this->removeSubtableMetadata($childTable);
}
} else {
foreach ($dataTable->getRows() as $row) {
$row->deleteMetadata('idsubdatatable_in_db');
}
}
}
/**
* Sets the subtable IDs for the DataTable returned by getSocial.
*
* The IDs are int indexes into the array in of defined socials.
*
* @param DataTable $dataTable
*/
private function setSocialIdSubtables($dataTable)
{
if ($dataTable instanceof DataTable\Map) {
foreach ($dataTable->getDataTables() as $childTable) {
$this->setSocialIdSubtables($childTable);
}
} else {
foreach ($dataTable->getRows() as $row) {
$socialName = $row->getColumn('label');
$i = 1;
// start at one because idSubtable=0 is equivalent to idSubtable=false
foreach (\Piwik\Plugins\Referrers\Social::getInstance()->getDefinitions() as $name) {
if ($name == $socialName) {
$row->setNonLoadedSubtableId($i);
break;
}
++$i;
}
}
}
}
/**
* Utility function that removes the subtable IDs for the subtables of the
* getReferrerType report. This avoids infinite recursion in said report (ie,
* the grandchildren of the report will be the original report, and it will
* recurse when trying to get a flat report).
*
* @param DataTable $table
* @return DataTable Returns $table for convenience.
*/
private function removeSubtableIds($table)
{
if ($table instanceof DataTable\Map) {
foreach ($table->getDataTables() as $childTable) {
$this->removeSubtableIds($childTable);
}
} else {
foreach ($table->getRows() as $row) {
$row->removeSubtable();
}
}
return $table;
}
/**
* @param int $idSite
* @param string $period
* @param string $date
* @param string|false $segment
* @param bool $expanded
* @param DataTable $dataTable
*/
private function buildExpandedTableForFlattenGetSocials($idSite, $period, $date, $segment, $expanded, $dataTable)
{
$urlsTable = Archive::createDataTableFromArchive(\Piwik\Plugins\Referrers\Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded, $flat = true);
$urlsTable->filter('ColumnCallbackDeleteRow', array('label', function ($url) {
return !\Piwik\Plugins\Referrers\Social::getInstance()->isSocialUrl($url);
}));
$urlsTable = $urlsTable->mergeSubtables();
if ($dataTable instanceof DataTable\Map) {
$dataTables = $dataTable->getDataTables();
$urlsTables = $urlsTable->getDataTables();
} else {
$dataTables = [$dataTable];
$urlsTables = [$urlsTable];
}
foreach ($dataTables as $label => $dataTable) {
foreach ($dataTable->getRows() as $row) {
$row->removeSubtable();
$social = $row->getColumn('label');
$newTable = $urlsTables[$label]->getEmptyClone();
$rows = $urlsTables[$label]->getRows();
foreach ($rows as $id => $urlsTableRow) {
$url = $urlsTableRow->getColumn('label');
if (\Piwik\Plugins\Referrers\Social::getInstance()->isSocialUrl($url, $social)) {
$newTable->addRow($urlsTableRow);
$urlsTables[$label]->deleteRow($id);
}
}
if ($newTable->getRowsCount()) {
$newTable->filter('Piwik\\Plugins\\Referrers\\DataTable\\Filter\\UrlsForSocial', array($expanded));
$row->setSubtable($newTable);
}
}
}
Common::destroy($urlsTable);
$urlsTable = null;
}
private function createReferrerTypeTable(DataTable\DataTableInterface $table)
{
if ($table instanceof DataTable) {
$nameToColumnId = array(Common::REFERRER_TYPE_SEARCH_ENGINE => 'Referrers_visitorsFromSearchEngines', Common::REFERRER_TYPE_SOCIAL_NETWORK => 'Referrers_visitorsFromSocialNetworks', Common::REFERRER_TYPE_DIRECT_ENTRY => 'Referrers_visitorsFromDirectEntry', Common::REFERRER_TYPE_WEBSITE => 'Referrers_visitorsFromWebsites', Common::REFERRER_TYPE_CAMPAIGN => 'Referrers_visitorsFromCampaigns');
$newRow = array_fill_keys(array_values($nameToColumnId), 0);
foreach ($table->getRows() as $row) {
$referrerType = $row->getMetadata('referrer_type');
if (empty($nameToColumnId[$referrerType])) {
continue;
}
$nameVar = $nameToColumnId[$referrerType];
$value = $row->getColumn(Metrics::INDEX_NB_VISITS);
$newRow[$nameVar] = $value;
}
$result = new DataTable\Simple();
$result->addRowFromSimpleArray($newRow);
return $result;
} else {
if ($table instanceof DataTable\Map) {
$result = new DataTable\Map();
$result->setKeyName($table->getKeyName());
foreach ($table->getDataTables() as $label => $childTable) {
if ($childTable->getRowsCount() > 0) {
$referrerTypeTable = $this->createReferrerTypeTable($childTable);
$result->addTable($referrerTypeTable, $label);
} else {
$result->addTable(new DataTable(), $label);
}
}
} else {
throw new \Exception("Unexpected DataTable type: " . get_class($table));
// sanity check
}
}
return $result;
}
private function mergeNumericArchives(DataTable\DataTableInterface $table, DataTable\DataTableInterface $numericArchives = null)
{
if ($table instanceof DataTable) {
/** @var DataTable $numericArchives */
if (empty($numericArchives)) {
return;
}
$table->setAllTableMetadata($numericArchives->getAllTableMetadata());
if ($numericArchives->getRowsCount() == 0) {
return;
}
if ($table->getRowsCountWithoutSummaryRow() == 0) {
$table->addRow(new DataTable\Row());
}
$row = $table->getFirstRow();
foreach ($numericArchives->getFirstRow() as $name => $value) {
$row->setColumn($name, $value);
}
} else {
if ($table instanceof DataTable\Map) {
foreach ($table->getDataTables() as $label => $childTable) {
$numericArchiveChildTable = $numericArchives->getTable($label);
$this->mergeNumericArchives($childTable, $numericArchiveChildTable);
}
} else {
throw new \Exception("Unexpected DataTable type: " . get_class($table));
// sanity check
}
}
}
}