add icons for Character groups
This commit is contained in:
coderkun
commit
2d9a41a5fe
3461 changed files with 594457 additions and 0 deletions
530
www/analytics/plugins/Referrers/API.php
Normal file
530
www/analytics/plugins/Referrers/API.php
Normal file
|
|
@ -0,0 +1,530 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\Plugins\Referrers;
|
||||
|
||||
use Exception;
|
||||
use Piwik\API\ResponseBuilder;
|
||||
use Piwik\Archive;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable\Row;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\Date;
|
||||
use Piwik\Metrics;
|
||||
use Piwik\Piwik;
|
||||
|
||||
/**
|
||||
* 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='http://piwik.org/docs/analytics-api/reference/#toc-metric-definitions' 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).
|
||||
*
|
||||
* The methods "getKeywordsForPageUrl" and "getKeywordsForPageTitle" are used to output the top keywords used to find a page.
|
||||
* Check out the widget <a href='http://demo.piwik.org/index.php?module=Widgetize&action=iframe&moduleToWidgetize=Referrers&actionToWidgetize=getKeywordsForPage&idSite=7&period=day&date=2011-02-15&disableLink=1' target='_blank'>"Top keywords used to find this page"</a> that you can easily re-use on your website.
|
||||
* @method static \Piwik\Plugins\Referrers\API getInstance()
|
||||
*/
|
||||
class API extends \Piwik\Plugin\API
|
||||
{
|
||||
/**
|
||||
* @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::getDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $idSubtable);
|
||||
$dataTable->filter('Sort', array(Metrics::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded));
|
||||
$dataTable->queueFilter('ReplaceColumnNames');
|
||||
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)
|
||||
{
|
||||
// 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_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(Archiver::REFERRER_TYPE_RECORD_NAME, $idSite, $period, $date, $segment);
|
||||
|
||||
if ($typeReferrer !== false) // 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)
|
||||
// NOTE: not yet possible to do this w/ DataTable\Map instances
|
||||
if (!($dataTable instanceof DataTable\Map)) {
|
||||
$this->setGetReferrerTypeSubtables($dataTable, $idSite, $period, $date, $segment, $expanded);
|
||||
}
|
||||
|
||||
// set referrer type column to readable value
|
||||
$dataTable->queueFilter('ColumnCallbackReplace', array('label', __NAMESPACE__ . '\getReferrerTypeLabel'));
|
||||
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a report that shows
|
||||
*/
|
||||
public function getAll($idSite, $period, $date, $segment = false)
|
||||
{
|
||||
$dataTable = $this->getReferrerType($idSite, $period, $date, $segment, $typeReferrer = false, $idSubtable = false, $expanded = true);
|
||||
|
||||
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->filter('Sort', array(Metrics::INDEX_NB_VISITS, 'desc'));
|
||||
$dataTable->queueFilter('ReplaceColumnNames');
|
||||
$dataTable->queueFilter('ReplaceSummaryRowLabel');
|
||||
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getKeywords($idSite, $period, $date, $segment = false, $expanded = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::KEYWORDS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded);
|
||||
$dataTable = $this->handleKeywordNotDefined($dataTable);
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
protected function handleKeywordNotDefined($dataTable)
|
||||
{
|
||||
$dataTable->queueFilter('ColumnCallbackReplace', array('label', __NAMESPACE__ . '\API::getCleanKeyword'));
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
const LABEL_KEYWORD_NOT_DEFINED = "";
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
static public function getKeywordNotDefinedString()
|
||||
{
|
||||
return Piwik::translate('General_NotDefined', Piwik::translate('General_ColumnKeyword'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
static public function getCleanKeyword($label)
|
||||
{
|
||||
return $label == self::LABEL_KEYWORD_NOT_DEFINED
|
||||
? self::getKeywordNotDefinedString()
|
||||
: $label;
|
||||
}
|
||||
|
||||
public function getKeywordsForPageUrl($idSite, $period, $date, $url)
|
||||
{
|
||||
// Fetch the Top keywords for this page
|
||||
$segment = 'entryPageUrl==' . $url;
|
||||
$table = $this->getKeywords($idSite, $period, $date, $segment);
|
||||
$this->filterOutKeywordNotDefined($table);
|
||||
return $this->getLabelsFromTable($table);
|
||||
}
|
||||
|
||||
public function getKeywordsForPageTitle($idSite, $period, $date, $title)
|
||||
{
|
||||
$segment = 'entryPageTitle==' . $title;
|
||||
$table = $this->getKeywords($idSite, $period, $date, $segment);
|
||||
$this->filterOutKeywordNotDefined($table);
|
||||
return $this->getLabelsFromTable($table);
|
||||
}
|
||||
|
||||
/**
|
||||
* @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)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::KEYWORDS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
|
||||
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', __NAMESPACE__ . '\getSearchEngineUrlFromName'));
|
||||
$dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', __NAMESPACE__ . '\getSearchEngineLogoFromUrl'));
|
||||
|
||||
// get the keyword and create the URL to the search result page
|
||||
$keywords = $this->getKeywords($idSite, $period, $date, $segment);
|
||||
$subTable = $keywords->getRowFromIdSubDataTable($idSubtable);
|
||||
if ($subTable) {
|
||||
$keyword = $subTable->getColumn('label');
|
||||
$dataTable->queueFilter('MetadataCallbackReplace', array('url', __NAMESPACE__ . '\getSearchEngineUrlFromUrlAndKeyword', array($keyword)));
|
||||
}
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getSearchEngines($idSite, $period, $date, $segment = false, $expanded = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::SEARCH_ENGINES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded);
|
||||
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', __NAMESPACE__ . '\getSearchEngineUrlFromName'));
|
||||
$dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', __NAMESPACE__ . '\getSearchEngineLogoFromUrl'));
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getKeywordsFromSearchEngineId($idSite, $period, $date, $idSubtable, $segment = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(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();
|
||||
|
||||
if ($searchEngines instanceof DataTable\Map) {
|
||||
$dataTables = $searchEngines->getDataTables();
|
||||
|
||||
// find first datatable containing data
|
||||
foreach ($dataTables AS $subTable) {
|
||||
|
||||
$subTableRow = $subTable->getRowFromIdSubDataTable($idSubtable);
|
||||
if (!empty($subTableRow)) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$subTableRow = $searchEngines->getRowFromIdSubDataTable($idSubtable);
|
||||
}
|
||||
|
||||
if (!empty($subTableRow)) {
|
||||
$searchEngineUrl = $subTableRow->getMetadata('url');
|
||||
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', __NAMESPACE__ . '\getSearchEngineUrlFromKeywordAndUrl', array($searchEngineUrl)));
|
||||
}
|
||||
$dataTable = $this->handleKeywordNotDefined($dataTable);
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getCampaigns($idSite, $period, $date, $segment = false, $expanded = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::CAMPAIGNS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded);
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getKeywordsFromCampaignId($idSite, $period, $date, $idSubtable, $segment = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::CAMPAIGNS_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getWebsites($idSite, $period, $date, $segment = false, $expanded = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded);
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getUrlsFromWebsiteId($idSite, $period, $date, $idSubtable, $segment = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = false, $idSubtable);
|
||||
// the htmlspecialchars_decode call is for BC for before 1.1
|
||||
// as the Referrer URL was previously encoded in the log tables, but is now recorded raw
|
||||
$dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', function ($label) {
|
||||
return htmlspecialchars_decode($label);
|
||||
}));
|
||||
$dataTable->queueFilter('ColumnCallbackReplace', array('label', __NAMESPACE__ . '\getPathFromUrl'));
|
||||
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
|
||||
* @return DataTable
|
||||
*/
|
||||
public function getSocials($idSite, $period, $date, $segment = false, $expanded = false)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded);
|
||||
|
||||
$dataTable->filter('ColumnCallbackDeleteRow', array('label', function ($url) { return !isSocialUrl($url); }));
|
||||
|
||||
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'url', __NAMESPACE__ . '\getSocialMainUrl'));
|
||||
$dataTable->filter('GroupBy', array('label', __NAMESPACE__ . '\getSocialNetworkFromDomain'));
|
||||
|
||||
$this->setSocialIdSubtables($dataTable);
|
||||
$this->removeSubtableMetadata($dataTable);
|
||||
|
||||
$dataTable->queueFilter('MetadataCallbackAddMetadata', array('url', 'logo', __NAMESPACE__ . '\getSocialsLogoFromUrl'));
|
||||
|
||||
return $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 /core/DataFiles/Socials.php 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)
|
||||
{
|
||||
$dataTable = $this->getDataTable(Archiver::WEBSITES_RECORD_NAME, $idSite, $period, $date, $segment, $expanded = true);
|
||||
|
||||
// get the social network domain referred to by $idSubtable
|
||||
$socialNetworks = Common::getSocialUrls();
|
||||
|
||||
$social = false;
|
||||
if ($idSubtable !== false) {
|
||||
--$idSubtable;
|
||||
|
||||
reset($socialNetworks);
|
||||
for ($i = 0; $i != (int)$idSubtable; ++$i) {
|
||||
next($socialNetworks);
|
||||
}
|
||||
|
||||
$social = current($socialNetworks);
|
||||
}
|
||||
|
||||
// filter out everything but social network indicated by $idSubtable
|
||||
$dataTable->filter(
|
||||
'ColumnCallbackDeleteRow',
|
||||
array('label',
|
||||
function ($url) use ($social) { return !isSocialUrl($url, $social); }
|
||||
)
|
||||
);
|
||||
|
||||
// merge the datatable's subtables which contain the individual URLs
|
||||
$dataTable = $dataTable->mergeSubtables();
|
||||
|
||||
// make url labels clickable
|
||||
$dataTable->filter('ColumnCallbackAddMetadata', array('label', 'url'));
|
||||
|
||||
// prettify the DataTable
|
||||
$dataTable->filter('ColumnCallbackReplace', array('label', __NAMESPACE__ . '\removeUrlProtocol'));
|
||||
$dataTable->filter('Sort', array(Metrics::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded));
|
||||
$dataTable->queueFilter('ReplaceColumnNames');
|
||||
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
public function getNumberOfDistinctSearchEngines($idSite, $period, $date, $segment = false)
|
||||
{
|
||||
return $this->getNumeric(Archiver::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME, $idSite, $period, $date, $segment);
|
||||
}
|
||||
|
||||
public function getNumberOfDistinctKeywords($idSite, $period, $date, $segment = false)
|
||||
{
|
||||
return $this->getNumeric(Archiver::METRIC_DISTINCT_KEYWORD_RECORD_NAME, $idSite, $period, $date, $segment);
|
||||
}
|
||||
|
||||
public function getNumberOfDistinctCampaigns($idSite, $period, $date, $segment = false)
|
||||
{
|
||||
return $this->getNumeric(Archiver::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME, $idSite, $period, $date, $segment);
|
||||
}
|
||||
|
||||
public function getNumberOfDistinctWebsites($idSite, $period, $date, $segment = false)
|
||||
{
|
||||
return $this->getNumeric(Archiver::METRIC_DISTINCT_WEBSITE_RECORD_NAME, $idSite, $period, $date, $segment);
|
||||
}
|
||||
|
||||
public function getNumberOfDistinctWebsitesUrls($idSite, $period, $date, $segment = false)
|
||||
{
|
||||
return $this->getNumeric(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 /core/DataFiles/Socials.php.
|
||||
*
|
||||
* @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 (Common::getSocialUrls() as $domain => $name) {
|
||||
if ($name == $socialName) {
|
||||
$row->c[Row::DATATABLE_ASSOCIATED] = $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;
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility function that sets the subtables for the getReferrerType report.
|
||||
*
|
||||
* If we're not getting an expanded datatable, the subtable ID is set to each parent
|
||||
* row's referrer type (stored in the label for the getReferrerType report).
|
||||
*
|
||||
* If we are getting an expanded datatable, the datatable for the row's referrer
|
||||
* type is loaded and attached to the appropriate row in the getReferrerType report.
|
||||
*
|
||||
* @param DataTable $dataTable
|
||||
* @param string $idSite
|
||||
* @param string $period
|
||||
* @param string $date
|
||||
* @param string $segment
|
||||
* @param bool $expanded
|
||||
*/
|
||||
private function setGetReferrerTypeSubtables($dataTable, $idSite, $period, $date, $segment, $expanded)
|
||||
{
|
||||
foreach ($dataTable->getRows() as $row) {
|
||||
$typeReferrer = $row->getColumn('label');
|
||||
if ($typeReferrer != Common::REFERRER_TYPE_DIRECT_ENTRY) {
|
||||
if (!$expanded) // if we don't want the expanded datatable, then don't do any extra queries
|
||||
{
|
||||
$row->c[Row::DATATABLE_ASSOCIATED] = $typeReferrer;
|
||||
} else // otherwise, we have to get the othe datatables
|
||||
{
|
||||
$subtable = $this->getReferrerType($idSite, $period, $date, $segment, $type = false,
|
||||
$idSubtable = $typeReferrer);
|
||||
|
||||
if ($expanded) {
|
||||
$subtable->applyQueuedFilters();
|
||||
}
|
||||
|
||||
$row->setSubtable($subtable);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
269
www/analytics/plugins/Referrers/Archiver.php
Normal file
269
www/analytics/plugins/Referrers/Archiver.php
Normal file
|
|
@ -0,0 +1,269 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\Plugins\Referrers;
|
||||
|
||||
use Exception;
|
||||
use Piwik\Common;
|
||||
use Piwik\Config;
|
||||
use Piwik\DataArray;
|
||||
use Piwik\Metrics;
|
||||
|
||||
class Archiver extends \Piwik\Plugin\Archiver
|
||||
{
|
||||
const SEARCH_ENGINES_RECORD_NAME = 'Referrers_keywordBySearchEngine';
|
||||
const KEYWORDS_RECORD_NAME = 'Referrers_searchEngineByKeyword';
|
||||
const CAMPAIGNS_RECORD_NAME = 'Referrers_keywordByCampaign';
|
||||
const WEBSITES_RECORD_NAME = 'Referrers_urlByWebsite';
|
||||
const REFERRER_TYPE_RECORD_NAME = 'Referrers_type';
|
||||
const METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME = 'Referrers_distinctSearchEngines';
|
||||
const METRIC_DISTINCT_KEYWORD_RECORD_NAME = 'Referrers_distinctKeywords';
|
||||
const METRIC_DISTINCT_CAMPAIGN_RECORD_NAME = 'Referrers_distinctCampaigns';
|
||||
const METRIC_DISTINCT_WEBSITE_RECORD_NAME = 'Referrers_distinctWebsites';
|
||||
const METRIC_DISTINCT_URLS_RECORD_NAME = 'Referrers_distinctWebsitesUrls';
|
||||
|
||||
protected $columnToSortByBeforeTruncation;
|
||||
protected $maximumRowsInDataTableLevelZero;
|
||||
protected $maximumRowsInSubDataTable;
|
||||
/**
|
||||
* @var DataArray[] $arrays
|
||||
*/
|
||||
protected $arrays = array();
|
||||
protected $distinctUrls = array();
|
||||
|
||||
function __construct($processor)
|
||||
{
|
||||
parent::__construct($processor);
|
||||
$this->columnToSortByBeforeTruncation = Metrics::INDEX_NB_VISITS;
|
||||
|
||||
// Reading pre 2.0 config file settings
|
||||
$this->maximumRowsInDataTableLevelZero = @Config::getInstance()->General['datatable_archiving_maximum_rows_referers'];
|
||||
$this->maximumRowsInSubDataTable = @Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referers'];
|
||||
if (empty($this->maximumRowsInDataTableLevelZero)) {
|
||||
$this->maximumRowsInDataTableLevelZero = Config::getInstance()->General['datatable_archiving_maximum_rows_referrers'];
|
||||
$this->maximumRowsInSubDataTable = Config::getInstance()->General['datatable_archiving_maximum_rows_subtable_referrers'];
|
||||
}
|
||||
}
|
||||
|
||||
public function aggregateDayReport()
|
||||
{
|
||||
foreach ($this->getRecordNames() as $record) {
|
||||
$this->arrays[$record] = new DataArray();
|
||||
}
|
||||
$this->aggregateFromVisits(array("referer_type", "referer_name", "referer_keyword", "referer_url"));
|
||||
$this->aggregateFromConversions(array("referer_type", "referer_name", "referer_keyword"));
|
||||
$this->insertDayReports();
|
||||
}
|
||||
|
||||
protected function getRecordNames()
|
||||
{
|
||||
return array(
|
||||
self::REFERRER_TYPE_RECORD_NAME,
|
||||
self::KEYWORDS_RECORD_NAME,
|
||||
self::SEARCH_ENGINES_RECORD_NAME,
|
||||
self::WEBSITES_RECORD_NAME,
|
||||
self::CAMPAIGNS_RECORD_NAME,
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
protected function makeReferrerTypeNonEmpty(&$row)
|
||||
{
|
||||
if (empty($row['referer_type'])) {
|
||||
$row['referer_type'] = Common::REFERRER_TYPE_DIRECT_ENTRY;
|
||||
}
|
||||
}
|
||||
|
||||
protected function aggregateVisitRow($row)
|
||||
{
|
||||
switch ($row['referer_type']) {
|
||||
case Common::REFERRER_TYPE_SEARCH_ENGINE:
|
||||
if (empty($row['referer_keyword'])) {
|
||||
$row['referer_keyword'] = API::LABEL_KEYWORD_NOT_DEFINED;
|
||||
}
|
||||
$searchEnginesArray = $this->getDataArray(self::SEARCH_ENGINES_RECORD_NAME);
|
||||
$searchEnginesArray->sumMetricsVisits($row['referer_name'], $row);
|
||||
$searchEnginesArray->sumMetricsVisitsPivot($row['referer_name'], $row['referer_keyword'], $row);
|
||||
$keywordsDataArray = $this->getDataArray(self::KEYWORDS_RECORD_NAME);
|
||||
$keywordsDataArray->sumMetricsVisits($row['referer_keyword'], $row);
|
||||
$keywordsDataArray->sumMetricsVisitsPivot($row['referer_keyword'], $row['referer_name'], $row);
|
||||
break;
|
||||
|
||||
case Common::REFERRER_TYPE_WEBSITE:
|
||||
$this->getDataArray(self::WEBSITES_RECORD_NAME)->sumMetricsVisits($row['referer_name'], $row);
|
||||
$this->getDataArray(self::WEBSITES_RECORD_NAME)->sumMetricsVisitsPivot($row['referer_name'], $row['referer_url'], $row);
|
||||
|
||||
$urlHash = substr(md5($row['referer_url']), 0, 10);
|
||||
if (!isset($this->distinctUrls[$urlHash])) {
|
||||
$this->distinctUrls[$urlHash] = true;
|
||||
}
|
||||
break;
|
||||
|
||||
case Common::REFERRER_TYPE_CAMPAIGN:
|
||||
if (!empty($row['referer_keyword'])) {
|
||||
$this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsVisitsPivot($row['referer_name'], $row['referer_keyword'], $row);
|
||||
}
|
||||
$this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsVisits($row['referer_name'], $row);
|
||||
break;
|
||||
|
||||
case Common::REFERRER_TYPE_DIRECT_ENTRY:
|
||||
// direct entry are aggregated below in $this->metricsByType array
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new Exception("Non expected referer_type = " . $row['referer_type']);
|
||||
break;
|
||||
}
|
||||
$this->getDataArray(self::REFERRER_TYPE_RECORD_NAME)->sumMetricsVisits($row['referer_type'], $row);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
* @return DataArray
|
||||
*/
|
||||
protected function getDataArray($name)
|
||||
{
|
||||
return $this->arrays[$name];
|
||||
}
|
||||
|
||||
protected function aggregateFromConversions($dimensions)
|
||||
{
|
||||
$query = $this->getLogAggregator()->queryConversionsByDimension($dimensions);
|
||||
if ($query === false) {
|
||||
return;
|
||||
}
|
||||
while ($row = $query->fetch()) {
|
||||
$this->makeReferrerTypeNonEmpty($row);
|
||||
|
||||
$skipAggregateByType = $this->aggregateConversionRow($row);
|
||||
if (!$skipAggregateByType) {
|
||||
$this->getDataArray(self::REFERRER_TYPE_RECORD_NAME)->sumMetricsGoals($row['referer_type'], $row);
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($this->arrays as $dataArray) {
|
||||
$dataArray->enrichMetricsWithConversions();
|
||||
}
|
||||
}
|
||||
|
||||
protected function aggregateConversionRow($row)
|
||||
{
|
||||
$skipAggregateByType = false;
|
||||
switch ($row['referer_type']) {
|
||||
case Common::REFERRER_TYPE_SEARCH_ENGINE:
|
||||
if (empty($row['referer_keyword'])) {
|
||||
$row['referer_keyword'] = API::LABEL_KEYWORD_NOT_DEFINED;
|
||||
}
|
||||
|
||||
$this->getDataArray(self::SEARCH_ENGINES_RECORD_NAME)->sumMetricsGoals($row['referer_name'], $row);
|
||||
$this->getDataArray(self::KEYWORDS_RECORD_NAME)->sumMetricsGoals($row['referer_keyword'], $row);
|
||||
break;
|
||||
|
||||
case Common::REFERRER_TYPE_WEBSITE:
|
||||
$this->getDataArray(self::WEBSITES_RECORD_NAME)->sumMetricsGoals($row['referer_name'], $row);
|
||||
break;
|
||||
|
||||
case Common::REFERRER_TYPE_CAMPAIGN:
|
||||
if (!empty($row['referer_keyword'])) {
|
||||
$this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsGoalsPivot($row['referer_name'], $row['referer_keyword'], $row);
|
||||
}
|
||||
$this->getDataArray(self::CAMPAIGNS_RECORD_NAME)->sumMetricsGoals($row['referer_name'], $row);
|
||||
break;
|
||||
|
||||
case Common::REFERRER_TYPE_DIRECT_ENTRY:
|
||||
// Direct entry, no sub dimension
|
||||
break;
|
||||
|
||||
default:
|
||||
// The referer type is user submitted for goal conversions, we ignore any malformed value
|
||||
// Continue to the next while iteration
|
||||
$skipAggregateByType = true;
|
||||
break;
|
||||
}
|
||||
return $skipAggregateByType;
|
||||
}
|
||||
|
||||
/**
|
||||
* Records the daily stats (numeric or datatable blob) into the archive tables.
|
||||
*/
|
||||
protected function insertDayReports()
|
||||
{
|
||||
$this->insertDayNumericMetrics();
|
||||
|
||||
// insert DataTable reports
|
||||
foreach ($this->getRecordNames() as $recordName) {
|
||||
$blob = $this->getDataArray($recordName)->asDataTable()->getSerialized($this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation);
|
||||
$this->getProcessor()->insertBlobRecord($recordName, $blob);
|
||||
}
|
||||
}
|
||||
|
||||
protected function insertDayNumericMetrics()
|
||||
{
|
||||
$numericRecords = array(
|
||||
self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME => count($this->getDataArray(self::SEARCH_ENGINES_RECORD_NAME)),
|
||||
self::METRIC_DISTINCT_KEYWORD_RECORD_NAME => count($this->getDataArray(self::KEYWORDS_RECORD_NAME)),
|
||||
self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME => count($this->getDataArray(self::CAMPAIGNS_RECORD_NAME)),
|
||||
self::METRIC_DISTINCT_WEBSITE_RECORD_NAME => count($this->getDataArray(self::WEBSITES_RECORD_NAME)),
|
||||
self::METRIC_DISTINCT_URLS_RECORD_NAME => count($this->distinctUrls),
|
||||
);
|
||||
|
||||
$this->getProcessor()->insertNumericRecords($numericRecords);
|
||||
}
|
||||
|
||||
public function aggregateMultipleReports()
|
||||
{
|
||||
$dataTableToSum = $this->getRecordNames();
|
||||
$nameToCount = $this->getProcessor()->aggregateDataTableRecords($dataTableToSum, $this->maximumRowsInDataTableLevelZero, $this->maximumRowsInSubDataTable, $this->columnToSortByBeforeTruncation);
|
||||
|
||||
$mappingFromArchiveName = array(
|
||||
self::METRIC_DISTINCT_SEARCH_ENGINE_RECORD_NAME =>
|
||||
array('typeCountToUse' => 'level0',
|
||||
'nameTableToUse' => self::SEARCH_ENGINES_RECORD_NAME,
|
||||
),
|
||||
self::METRIC_DISTINCT_KEYWORD_RECORD_NAME =>
|
||||
array('typeCountToUse' => 'level0',
|
||||
'nameTableToUse' => self::KEYWORDS_RECORD_NAME,
|
||||
),
|
||||
self::METRIC_DISTINCT_CAMPAIGN_RECORD_NAME =>
|
||||
array('typeCountToUse' => 'level0',
|
||||
'nameTableToUse' => self::CAMPAIGNS_RECORD_NAME,
|
||||
),
|
||||
self::METRIC_DISTINCT_WEBSITE_RECORD_NAME =>
|
||||
array('typeCountToUse' => 'level0',
|
||||
'nameTableToUse' => self::WEBSITES_RECORD_NAME,
|
||||
),
|
||||
self::METRIC_DISTINCT_URLS_RECORD_NAME =>
|
||||
array('typeCountToUse' => 'recursive',
|
||||
'nameTableToUse' => self::WEBSITES_RECORD_NAME,
|
||||
),
|
||||
);
|
||||
|
||||
foreach ($mappingFromArchiveName as $name => $infoMapping) {
|
||||
$nameTableToUse = $infoMapping['nameTableToUse'];
|
||||
|
||||
if ($infoMapping['typeCountToUse'] == 'recursive') {
|
||||
$countValue = $nameToCount[$nameTableToUse]['recursive'] - $nameToCount[$nameTableToUse]['level0'];
|
||||
} else {
|
||||
$countValue = $nameToCount[$nameTableToUse]['level0'];
|
||||
}
|
||||
$this->getProcessor()->insertNumericRecord($name, $countValue);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $fields
|
||||
*/
|
||||
private function aggregateFromVisits($fields)
|
||||
{
|
||||
$query = $this->getLogAggregator()->queryVisitsByDimension($fields);
|
||||
while ($row = $query->fetch()) {
|
||||
$this->makeReferrerTypeNonEmpty($row);
|
||||
$this->aggregateVisitRow($row);
|
||||
}
|
||||
}
|
||||
}
|
||||
533
www/analytics/plugins/Referrers/Controller.php
Normal file
533
www/analytics/plugins/Referrers/Controller.php
Normal file
|
|
@ -0,0 +1,533 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\Plugins\Referrers;
|
||||
|
||||
use Piwik\API\Request;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable\Map;
|
||||
use Piwik\Metrics;
|
||||
use Piwik\Period\Range;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\SettingsPiwik;
|
||||
use Piwik\Url;
|
||||
use Piwik\View;
|
||||
use Piwik\ViewDataTable\Factory;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
class Controller extends \Piwik\Plugin\Controller
|
||||
{
|
||||
public function index()
|
||||
{
|
||||
$view = new View('@Referrers/index');
|
||||
|
||||
$view->graphEvolutionReferrers = $this->getEvolutionGraph(Common::REFERRER_TYPE_DIRECT_ENTRY, array('nb_visits'));
|
||||
$view->nameGraphEvolutionReferrers = 'Referrers.getEvolutionGraph';
|
||||
|
||||
// building the referrers summary report
|
||||
$view->dataTableReferrerType = $this->getReferrerType(true);
|
||||
|
||||
$nameValues = $this->getReferrersVisitorsByType();
|
||||
|
||||
$totalVisits = array_sum($nameValues);
|
||||
foreach ($nameValues as $name => $value) {
|
||||
$view->$name = $value;
|
||||
|
||||
// calculate percent of total, if there were any visits
|
||||
if ($value != 0
|
||||
&& $totalVisits != 0
|
||||
) {
|
||||
$percentName = $name . 'Percent';
|
||||
$view->$percentName = round(($value / $totalVisits) * 100, 0);
|
||||
}
|
||||
}
|
||||
|
||||
// set distinct metrics
|
||||
$distinctMetrics = $this->getDistinctReferrersMetrics();
|
||||
foreach ($distinctMetrics as $name => $value) {
|
||||
$view->$name = $value;
|
||||
}
|
||||
|
||||
// calculate evolution for visit metrics & distinct metrics
|
||||
list($lastPeriodDate, $ignore) = Range::getLastDate();
|
||||
if ($lastPeriodDate !== false) {
|
||||
$date = Common::getRequestVar('date');
|
||||
$period = Common::getRequestVar('period');
|
||||
|
||||
$prettyDate = self::getPrettyDate($date, $period);
|
||||
$prettyLastPeriodDate = self::getPrettyDate($lastPeriodDate, $period);
|
||||
|
||||
// visit metrics
|
||||
$previousValues = $this->getReferrersVisitorsByType($lastPeriodDate);
|
||||
$this->addEvolutionPropertiesToView($view, $prettyDate, $nameValues, $prettyLastPeriodDate, $previousValues);
|
||||
|
||||
// distinct metrics
|
||||
$previousValues = $this->getDistinctReferrersMetrics($lastPeriodDate);
|
||||
$this->addEvolutionPropertiesToView($view, $prettyDate, $distinctMetrics, $prettyLastPeriodDate, $previousValues);
|
||||
}
|
||||
|
||||
// sparkline for the historical data of the above values
|
||||
$view->urlSparklineSearchEngines = $this->getReferrerUrlSparkline(Common::REFERRER_TYPE_SEARCH_ENGINE);
|
||||
$view->urlSparklineDirectEntry = $this->getReferrerUrlSparkline(Common::REFERRER_TYPE_DIRECT_ENTRY);
|
||||
$view->urlSparklineWebsites = $this->getReferrerUrlSparkline(Common::REFERRER_TYPE_WEBSITE);
|
||||
$view->urlSparklineCampaigns = $this->getReferrerUrlSparkline(Common::REFERRER_TYPE_CAMPAIGN);
|
||||
|
||||
// sparklines for the evolution of the distinct keywords count/websites count/ etc
|
||||
$view->urlSparklineDistinctSearchEngines = $this->getUrlSparkline('getLastDistinctSearchEnginesGraph');
|
||||
$view->urlSparklineDistinctKeywords = $this->getUrlSparkline('getLastDistinctKeywordsGraph');
|
||||
$view->urlSparklineDistinctWebsites = $this->getUrlSparkline('getLastDistinctWebsitesGraph');
|
||||
$view->urlSparklineDistinctCampaigns = $this->getUrlSparkline('getLastDistinctCampaignsGraph');
|
||||
|
||||
$view->totalVisits = $totalVisits;
|
||||
$view->referrersReportsByDimension = $this->getReferrersReportsByDimensionView($totalVisits);
|
||||
|
||||
return $view->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns HTML for the Referrers Overview page that categorizes Referrer reports
|
||||
* & allows the user to switch between them.
|
||||
*
|
||||
* @param int $visits The number of visits for this period & site. If <= 0, the
|
||||
* reports are not shown, since they will have no data.getReferrersReportsByDimensionView
|
||||
* @return string The report viewer HTML.
|
||||
*/
|
||||
private function getReferrersReportsByDimensionView($visits)
|
||||
{
|
||||
$result = '';
|
||||
|
||||
// only display the reports by dimension view if there are visits
|
||||
if ($visits > 0) {
|
||||
$referrersReportsByDimension = new View\ReportsByDimension('Referrers');
|
||||
|
||||
$referrersReportsByDimension->addReport(
|
||||
'Referrers_ViewAllReferrers', 'Referrers_WidgetGetAll', 'Referrers.getAll');
|
||||
|
||||
$byTypeCategory = Piwik::translate('Referrers_ViewReferrersBy', Piwik::translate('Live_GoalType'));
|
||||
$referrersReportsByDimension->addReport(
|
||||
$byTypeCategory, 'Referrers_WidgetKeywords', 'Referrers.getKeywords');
|
||||
$referrersReportsByDimension->addReport($byTypeCategory, 'SitesManager_Sites', 'Referrers.getWebsites');
|
||||
$referrersReportsByDimension->addReport($byTypeCategory, 'Referrers_Campaigns', 'Referrers.getCampaigns');
|
||||
|
||||
$bySourceCategory = Piwik::translate('Referrers_ViewReferrersBy', Piwik::translate('General_Source'));
|
||||
$referrersReportsByDimension->addReport($bySourceCategory, 'Referrers_Socials', 'Referrers.getSocials');
|
||||
$referrersReportsByDimension->addReport(
|
||||
$bySourceCategory, 'Referrers_SearchEngines', 'Referrers.getSearchEngines');
|
||||
|
||||
$result = $referrersReportsByDimension->render();
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
public function getSearchEnginesAndKeywords()
|
||||
{
|
||||
$view = new View('@Referrers/getSearchEnginesAndKeywords');
|
||||
$view->searchEngines = $this->getSearchEngines(true);
|
||||
$view->keywords = $this->getKeywords(true);
|
||||
return $view->render();
|
||||
}
|
||||
|
||||
public function getReferrerType()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns or echo's a report that shows all search keyword, website and campaign
|
||||
* referrer information in one report.
|
||||
*
|
||||
* @return string The report HTML or nothing if $fetch is set to false.
|
||||
*/
|
||||
public function getAll()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getKeywords()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getSearchEnginesFromKeywordId()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getSearchEngines()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getKeywordsFromSearchEngineId()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function indexWebsites()
|
||||
{
|
||||
$view = new View('@Referrers/indexWebsites');
|
||||
$view->websites = $this->getWebsites(true);
|
||||
$view->socials = $this->getSocials(true);
|
||||
|
||||
return $view->render();
|
||||
}
|
||||
|
||||
public function getWebsites()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getSocials()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getUrlsForSocial()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function indexCampaigns()
|
||||
{
|
||||
return View::singleReport(
|
||||
Piwik::translate('Referrers_Campaigns'),
|
||||
$this->getCampaigns(true));
|
||||
}
|
||||
|
||||
public function getCampaigns()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getKeywordsFromCampaignId()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
public function getUrlsFromWebsiteId()
|
||||
{
|
||||
return $this->renderReport(__FUNCTION__);
|
||||
}
|
||||
|
||||
protected function getReferrersVisitorsByType($date = false)
|
||||
{
|
||||
if ($date === false) {
|
||||
$date = Common::getRequestVar('date', false);
|
||||
}
|
||||
|
||||
// we disable the queued filters because here we want to get the visits coming from search engines
|
||||
// if the filters were applied we would have to look up for a label looking like "Search Engines"
|
||||
// which is not good when we have translations
|
||||
$dataTableReferrersType = Request::processRequest(
|
||||
"Referrers.getReferrerType", array('disable_queued_filters' => '1', 'date' => $date));
|
||||
|
||||
$nameToColumnId = array(
|
||||
'visitorsFromSearchEngines' => Common::REFERRER_TYPE_SEARCH_ENGINE,
|
||||
'visitorsFromDirectEntry' => Common::REFERRER_TYPE_DIRECT_ENTRY,
|
||||
'visitorsFromWebsites' => Common::REFERRER_TYPE_WEBSITE,
|
||||
'visitorsFromCampaigns' => Common::REFERRER_TYPE_CAMPAIGN,
|
||||
);
|
||||
$return = array();
|
||||
foreach ($nameToColumnId as $nameVar => $columnId) {
|
||||
$value = 0;
|
||||
$row = $dataTableReferrersType->getRowFromLabel($columnId);
|
||||
if ($row !== false) {
|
||||
$value = $row->getColumn(Metrics::INDEX_NB_VISITS);
|
||||
}
|
||||
$return[$nameVar] = $value;
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
protected $referrerTypeToLabel = array(
|
||||
Common::REFERRER_TYPE_DIRECT_ENTRY => 'Referrers_DirectEntry',
|
||||
Common::REFERRER_TYPE_SEARCH_ENGINE => 'Referrers_SearchEngines',
|
||||
Common::REFERRER_TYPE_WEBSITE => 'Referrers_Websites',
|
||||
Common::REFERRER_TYPE_CAMPAIGN => 'Referrers_Campaigns',
|
||||
);
|
||||
|
||||
public function getEvolutionGraph($typeReferrer = false, array $columns = array())
|
||||
{
|
||||
$view = $this->getLastUnitGraph($this->pluginName, __FUNCTION__, 'Referrers.getReferrerType');
|
||||
|
||||
$view->config->add_total_row = true;
|
||||
|
||||
// configure displayed columns
|
||||
if (empty($columns)) {
|
||||
$columns = Common::getRequestVar('columns');
|
||||
$columns = Piwik::getArrayFromApiParameter($columns);
|
||||
}
|
||||
$columns = !is_array($columns) ? array($columns) : $columns;
|
||||
$view->config->columns_to_display = $columns;
|
||||
|
||||
// configure selectable columns
|
||||
if (Common::getRequestVar('period', false) == 'day') {
|
||||
$selectable = array('nb_visits', 'nb_uniq_visitors', 'nb_actions');
|
||||
} else {
|
||||
$selectable = array('nb_visits', 'nb_actions');
|
||||
}
|
||||
$view->config->selectable_columns = $selectable;
|
||||
|
||||
// configure displayed rows
|
||||
$visibleRows = Common::getRequestVar('rows', false);
|
||||
if ($visibleRows !== false) {
|
||||
// this happens when the row picker has been used
|
||||
$visibleRows = Piwik::getArrayFromApiParameter($visibleRows);
|
||||
|
||||
// typeReferrer is redundant if rows are defined, so make sure it's not used
|
||||
$view->config->custom_parameters['typeReferrer'] = false;
|
||||
} else {
|
||||
// use $typeReferrer as default
|
||||
if ($typeReferrer === false) {
|
||||
$typeReferrer = Common::getRequestVar('typeReferrer', false);
|
||||
}
|
||||
$label = self::getTranslatedReferrerTypeLabel($typeReferrer);
|
||||
$total = Piwik::translate('General_Total');
|
||||
$visibleRows = array($label, $total);
|
||||
$view->requestConfig->request_parameters_to_modify['rows'] = $label . ',' . $total;
|
||||
}
|
||||
$view->config->row_picker_match_rows_by = 'label';
|
||||
$view->config->rows_to_display = $visibleRows;
|
||||
|
||||
$view->config->documentation = Piwik::translate('Referrers_EvolutionDocumentation') . '<br />'
|
||||
. Piwik::translate('General_BrokenDownReportDocumentation') . '<br />'
|
||||
. Piwik::translate('Referrers_EvolutionDocumentationMoreInfo', '"'
|
||||
. Piwik::translate('Referrers_DetailsByReferrerType') . '"');
|
||||
|
||||
return $this->renderView($view);
|
||||
}
|
||||
|
||||
public function getLastDistinctSearchEnginesGraph()
|
||||
{
|
||||
$view = $this->getLastUnitGraph($this->pluginName, __FUNCTION__, "Referrers.getNumberOfDistinctSearchEngines");
|
||||
$view->config->translations['Referrers_distinctSearchEngines'] = ucfirst(Piwik::translate('Referrers_DistinctSearchEngines'));
|
||||
$view->config->columns_to_display = array('Referrers_distinctSearchEngines');
|
||||
return $this->renderView($view);
|
||||
}
|
||||
|
||||
public function getLastDistinctKeywordsGraph()
|
||||
{
|
||||
$view = $this->getLastUnitGraph($this->pluginName, __FUNCTION__, "Referrers.getNumberOfDistinctKeywords");
|
||||
$view->config->translations['Referrers_distinctKeywords'] = ucfirst(Piwik::translate('Referrers_DistinctKeywords'));
|
||||
$view->config->columns_to_display = array('Referrers_distinctKeywords');
|
||||
return $this->renderView($view);
|
||||
}
|
||||
|
||||
public function getLastDistinctWebsitesGraph()
|
||||
{
|
||||
$view = $this->getLastUnitGraph($this->pluginName, __FUNCTION__, "Referrers.getNumberOfDistinctWebsites");
|
||||
$view->config->translations['Referrers_distinctWebsites'] = ucfirst(Piwik::translate('Referrers_DistinctWebsites'));
|
||||
$view->config->columns_to_display = array('Referrers_distinctWebsites');
|
||||
return $this->renderView($view);
|
||||
}
|
||||
|
||||
public function getLastDistinctCampaignsGraph()
|
||||
{
|
||||
$view = $this->getLastUnitGraph($this->pluginName, __FUNCTION__, "Referrers.getNumberOfDistinctCampaigns");
|
||||
$view->config->translations['Referrers_distinctCampaigns'] = ucfirst(Piwik::translate('Referrers_DistinctCampaigns'));
|
||||
$view->config->columns_to_display = array('Referrers_distinctCampaigns');
|
||||
return $this->renderView($view);
|
||||
}
|
||||
|
||||
function getKeywordsForPage()
|
||||
{
|
||||
Piwik::checkUserHasViewAccess($this->idSite);
|
||||
|
||||
$requestUrl = '&date=previous1'
|
||||
. '&period=week'
|
||||
. '&idSite=' . $this->idSite;
|
||||
|
||||
$topPageUrlRequest = $requestUrl
|
||||
. '&method=Actions.getPageUrls'
|
||||
. '&filter_limit=50'
|
||||
. '&format=original';
|
||||
$request = new Request($topPageUrlRequest);
|
||||
$request = $request->process();
|
||||
/** @var $request Map */
|
||||
$tables = $request->getDataTables();;
|
||||
|
||||
$topPageUrl = false;
|
||||
$first = key($tables);
|
||||
if (!empty($first)) {
|
||||
$topPageUrls = $tables[$first];
|
||||
$topPageUrls = $topPageUrls->getRowsMetadata('url');
|
||||
$tmpTopPageUrls = array_values($topPageUrls);
|
||||
$topPageUrl = current($tmpTopPageUrls);
|
||||
}
|
||||
if (empty($topPageUrl)) {
|
||||
$topPageUrl = $this->site->getMainUrl();
|
||||
}
|
||||
$url = $topPageUrl;
|
||||
|
||||
// HTML
|
||||
$api = SettingsPiwik::getPiwikUrl()
|
||||
. '?module=API&method=Referrers.getKeywordsForPageUrl'
|
||||
. '&format=php'
|
||||
. '&filter_limit=10'
|
||||
. '&token_auth=' . Piwik::getCurrentUserTokenAuth();
|
||||
|
||||
$api .= $requestUrl;
|
||||
$code = '
|
||||
// This function will call the API to get best keyword for current URL.
|
||||
// Then it writes the list of best keywords in a HTML list
|
||||
function DisplayTopKeywords($url = "")
|
||||
{
|
||||
// Do not spend more than 1 second fetching the data
|
||||
@ini_set("default_socket_timeout", $timeout = 1);
|
||||
// Get the Keywords data
|
||||
$url = empty($url) ? "http://". $_SERVER["HTTP_HOST"] . $_SERVER["REQUEST_URI"] : $url;
|
||||
$api = "' . $api . '&url=" . urlencode($url);
|
||||
$keywords = @unserialize(file_get_contents($api));
|
||||
if($keywords === false || isset($keywords["result"])) {
|
||||
// DEBUG ONLY: uncomment for troubleshooting an empty output (the URL output reveals the token_auth)
|
||||
// echo "Error while fetching the <a href=\'$api\'>Top Keywords from Piwik</a>";
|
||||
return;
|
||||
}
|
||||
|
||||
// Display the list in HTML
|
||||
$url = htmlspecialchars($url, ENT_QUOTES);
|
||||
$output = "<h2>Top Keywords for <a href=\'$url\'>$url</a></h2><ul>";
|
||||
foreach($keywords as $keyword) {
|
||||
$output .= "<li>". $keyword . "</li>";
|
||||
}
|
||||
if(empty($keywords)) { $output .= "Nothing yet..."; }
|
||||
$output .= "</ul>";
|
||||
echo $output;
|
||||
}
|
||||
';
|
||||
|
||||
$jsonRequest = str_replace('format=php', 'format=json', $api);
|
||||
echo "<p>This widget is designed to work in your website directly.
|
||||
This widget makes it easy to use Piwik to <i>automatically display the list of Top Keywords</i>, for each of your website Page URLs.</p>
|
||||
<p>
|
||||
<b>Example API URL</b> - For example if you would like to get the top 10 keywords, used last week, to land on the page <a target='_blank' href='$topPageUrl'>$topPageUrl</a>,
|
||||
in format JSON: you would dynamically fetch the data using <a target='_blank' href='$jsonRequest&url=" . urlencode($topPageUrl) . "'>this API request URL</a>. Make sure you encode the 'url' parameter in the URL.</p>
|
||||
|
||||
<p><b>PHP Function ready to use!</b> - If you use PHP on your website, we have prepared a small code snippet that you can copy paste in your Website PHP files. You can then simply call the function <code>DisplayTopKeywords();</code> anywhere in your template, at the bottom of the content or in your blog sidebar.
|
||||
If you run this code in your page $topPageUrl, it would output the following:";
|
||||
|
||||
echo "<div style='width:400px;margin-left:20px;padding:10px;border:1px solid black;'>";
|
||||
function DisplayTopKeywords($url = "", $api)
|
||||
{
|
||||
// Do not spend more than 1 second fetching the data
|
||||
@ini_set("default_socket_timeout", $timeout = 1);
|
||||
// Get the Keywords data
|
||||
$url = empty($url) ? "http://" . $_SERVER["HTTP_HOST"] . $_SERVER["REQUEST_URI"] : $url;
|
||||
$api = $api . "&url=" . urlencode($url);
|
||||
$keywords = @unserialize(file_get_contents($api));
|
||||
if ($keywords === false || isset($keywords["result"])) {
|
||||
// DEBUG ONLY: uncomment for troubleshooting an empty output (the URL output reveals the token_auth)
|
||||
//echo "Error while fetching the <a href=\'".$api."\'>Top Keywords from Piwik</a>";
|
||||
return;
|
||||
}
|
||||
|
||||
// Display the list in HTML
|
||||
$url = htmlspecialchars($url, ENT_QUOTES);
|
||||
$output = "<h2>Top Keywords for <a href=\'$url\'>$url</a></h2><ul>";
|
||||
foreach ($keywords as $keyword) {
|
||||
$output .= "<li>" . $keyword . "</li>";
|
||||
}
|
||||
if (empty($keywords)) {
|
||||
$output .= "Nothing yet...";
|
||||
}
|
||||
$output .= "</ul>";
|
||||
echo $output;
|
||||
}
|
||||
|
||||
DisplayTopKeywords($topPageUrl, $api);
|
||||
|
||||
echo "</div><br/>
|
||||
<p>Here is the PHP function that you can paste in your pages:</P>
|
||||
<textarea cols=60 rows=8><?php\n" . htmlspecialchars($code) . "\n DisplayTopKeywords();</textarea>
|
||||
";
|
||||
|
||||
echo "
|
||||
<p><strong>Notes</strong>: You can for example edit the code to to make the Top search keywords link to your Website search result pages.
|
||||
<br/>On medium to large traffic websites, we recommend to cache this data, as to minimize the performance impact of calling the Piwik API on each page view.
|
||||
</p>
|
||||
";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the i18n-ized label for a referrer type.
|
||||
*
|
||||
* @param int $typeReferrer The referrer type. Referrer types are defined in Common class.
|
||||
* @return string The i18n-ized label.
|
||||
*/
|
||||
public static function getTranslatedReferrerTypeLabel($typeReferrer)
|
||||
{
|
||||
$label = getReferrerTypeLabel($typeReferrer);
|
||||
return Piwik::translate($label);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URL for the sparkline of visits with a specific referrer type.
|
||||
*
|
||||
* @param int $referrerType The referrer type. Referrer types are defined in Common class.
|
||||
* @return string The URL that can be used to get a sparkline image.
|
||||
*/
|
||||
private function getReferrerUrlSparkline($referrerType)
|
||||
{
|
||||
$totalRow = Piwik::translate('General_Total');
|
||||
return $this->getUrlSparkline(
|
||||
'getEvolutionGraph',
|
||||
array('columns' => array('nb_visits'),
|
||||
'rows' => array(self::getTranslatedReferrerTypeLabel($referrerType), $totalRow),
|
||||
'typeReferrer' => $referrerType)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array containing the number of distinct referrers for each
|
||||
* referrer type.
|
||||
*
|
||||
* @param bool|string $date The date to use when getting metrics. If false, the
|
||||
* date query param is used.
|
||||
* @return array The metrics.
|
||||
*/
|
||||
private function getDistinctReferrersMetrics($date = false)
|
||||
{
|
||||
$propertyToAccessorMapping = array(
|
||||
'numberDistinctSearchEngines' => 'getNumberOfDistinctSearchEngines',
|
||||
'numberDistinctKeywords' => 'getNumberOfDistinctKeywords',
|
||||
'numberDistinctWebsites' => 'getNumberOfDistinctWebsites',
|
||||
'numberDistinctWebsitesUrls' => 'getNumberOfDistinctWebsitesUrls',
|
||||
'numberDistinctCampaigns' => 'getNumberOfDistinctCampaigns',
|
||||
);
|
||||
|
||||
$result = array();
|
||||
foreach ($propertyToAccessorMapping as $property => $method) {
|
||||
$result[$property] = $this->getNumericValue('Referrers.' . $method, $date);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility method that calculates evolution values for a set of current & past values
|
||||
* and sets properties on a View w/ HTML that displays the evolution percents.
|
||||
*
|
||||
* @param View $view The view to set properties on.
|
||||
* @param string $date The date of the current values.
|
||||
* @param array $currentValues Array mapping view property names w/ present values.
|
||||
* @param string $lastPeriodDate The date of the period in the past.
|
||||
* @param array $previousValues Array mapping view property names w/ past values. Keys
|
||||
* in this array should be the same as keys in $currentValues.
|
||||
*/
|
||||
private function addEvolutionPropertiesToView($view, $date, $currentValues, $lastPeriodDate, $previousValues)
|
||||
{
|
||||
foreach ($previousValues as $name => $pastValue) {
|
||||
$currentValue = $currentValues[$name];
|
||||
$evolutionName = $name . 'Evolution';
|
||||
|
||||
$view->$evolutionName = $this->getEvolutionHtml($date, $currentValue, $lastPeriodDate, $pastValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
546
www/analytics/plugins/Referrers/Referrers.php
Normal file
546
www/analytics/plugins/Referrers/Referrers.php
Normal file
|
|
@ -0,0 +1,546 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\Plugins\Referrers;
|
||||
|
||||
use Piwik\ArchiveProcessor;
|
||||
use Piwik\Common;
|
||||
use Piwik\Menu\MenuMain;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\Plugin\ViewDataTable;
|
||||
use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable\AllColumns;
|
||||
use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
|
||||
use Piwik\Plugins\CoreVisualizations\Visualizations\JqplotGraph\Pie;
|
||||
use Piwik\SettingsPiwik;
|
||||
use Piwik\WidgetsList;
|
||||
|
||||
/**
|
||||
* @see plugins/Referrers/functions.php
|
||||
*/
|
||||
require_once PIWIK_INCLUDE_PATH . '/plugins/Referrers/functions.php';
|
||||
|
||||
/**
|
||||
*/
|
||||
class Referrers extends \Piwik\Plugin
|
||||
{
|
||||
/**
|
||||
* @see Piwik\Plugin::getListHooksRegistered
|
||||
*/
|
||||
public function getListHooksRegistered()
|
||||
{
|
||||
$hooks = array(
|
||||
'WidgetsList.addWidgets' => 'addWidgets',
|
||||
'Menu.Reporting.addItems' => 'addMenus',
|
||||
'Goals.getReportsWithGoalMetrics' => 'getReportsWithGoalMetrics',
|
||||
'API.getReportMetadata' => 'getReportMetadata',
|
||||
'API.getSegmentDimensionMetadata' => 'getSegmentsMetadata',
|
||||
'ViewDataTable.configure' => 'configureViewDataTable',
|
||||
'ViewDataTable.getDefaultType' => 'getDefaultTypeViewDataTable',
|
||||
'Insights.addReportToOverview' => 'addReportToInsightsOverview'
|
||||
);
|
||||
return $hooks;
|
||||
}
|
||||
|
||||
public function addReportToInsightsOverview(&$reports)
|
||||
{
|
||||
$reports['Referrers_getWebsites'] = array();
|
||||
$reports['Referrers_getCampaigns'] = array();
|
||||
$reports['Referrers_getSocials'] = array();
|
||||
$reports['Referrers_getSearchEngines'] = array();
|
||||
}
|
||||
|
||||
public function getReportMetadata(&$reports)
|
||||
{
|
||||
$reports = array_merge($reports, array(
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Type'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getReferrerType',
|
||||
'dimension' => Piwik::translate('Referrers_Type'),
|
||||
'constantRowsCount' => true,
|
||||
'documentation' => Piwik::translate('Referrers_TypeReportDocumentation') . '<br />'
|
||||
. '<b>' . Piwik::translate('Referrers_DirectEntry') . ':</b> ' . Piwik::translate('Referrers_DirectEntryDocumentation') . '<br />'
|
||||
. '<b>' . Piwik::translate('Referrers_SearchEngines') . ':</b> ' . Piwik::translate('Referrers_SearchEnginesDocumentation',
|
||||
array('<br />', '"' . Piwik::translate('Referrers_SubmenuSearchEngines') . '"')) . '<br />'
|
||||
. '<b>' . Piwik::translate('Referrers_Websites') . ':</b> ' . Piwik::translate('Referrers_WebsitesDocumentation',
|
||||
array('<br />', '"' . Piwik::translate('Referrers_SubmenuWebsites') . '"')) . '<br />'
|
||||
. '<b>' . Piwik::translate('Referrers_Campaigns') . ':</b> ' . Piwik::translate('Referrers_CampaignsDocumentation',
|
||||
array('<br />', '"' . Piwik::translate('Referrers_Campaigns') . '"')),
|
||||
'order' => 1,
|
||||
),
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_WidgetGetAll'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getAll',
|
||||
'dimension' => Piwik::translate('Referrers_Referrer'),
|
||||
'documentation' => Piwik::translate('Referrers_AllReferrersReportDocumentation', '<br />'),
|
||||
'order' => 2,
|
||||
),
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Keywords'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getKeywords',
|
||||
'actionToLoadSubTables' => 'getSearchEnginesFromKeywordId',
|
||||
'dimension' => Piwik::translate('General_ColumnKeyword'),
|
||||
'documentation' => Piwik::translate('Referrers_KeywordsReportDocumentation', '<br />'),
|
||||
'order' => 3,
|
||||
),
|
||||
array( // subtable report
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Keywords'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getSearchEnginesFromKeywordId',
|
||||
'dimension' => Piwik::translate('Referrers_ColumnSearchEngine'),
|
||||
'documentation' => Piwik::translate('Referrers_KeywordsReportDocumentation', '<br />'),
|
||||
'isSubtableReport' => true,
|
||||
'order' => 4
|
||||
),
|
||||
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Websites'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getWebsites',
|
||||
'dimension' => Piwik::translate('Referrers_ColumnWebsite'),
|
||||
'documentation' => Piwik::translate('Referrers_WebsitesReportDocumentation', '<br />'),
|
||||
'actionToLoadSubTables' => 'getUrlsFromWebsiteId',
|
||||
'order' => 5
|
||||
),
|
||||
array( // subtable report
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Websites'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getUrlsFromWebsiteId',
|
||||
'dimension' => Piwik::translate('Referrers_ColumnWebsitePage'),
|
||||
'documentation' => Piwik::translate('Referrers_WebsitesReportDocumentation', '<br />'),
|
||||
'isSubtableReport' => true,
|
||||
'order' => 6,
|
||||
),
|
||||
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_SearchEngines'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getSearchEngines',
|
||||
'dimension' => Piwik::translate('Referrers_ColumnSearchEngine'),
|
||||
'documentation' => Piwik::translate('Referrers_SearchEnginesReportDocumentation', '<br />'),
|
||||
'actionToLoadSubTables' => 'getKeywordsFromSearchEngineId',
|
||||
'order' => 7,
|
||||
),
|
||||
array( // subtable report
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_SearchEngines'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getKeywordsFromSearchEngineId',
|
||||
'dimension' => Piwik::translate('General_ColumnKeyword'),
|
||||
'documentation' => Piwik::translate('Referrers_SearchEnginesReportDocumentation', '<br />'),
|
||||
'isSubtableReport' => true,
|
||||
'order' => 8,
|
||||
),
|
||||
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Campaigns'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getCampaigns',
|
||||
'dimension' => Piwik::translate('Referrers_ColumnCampaign'),
|
||||
'documentation' => Piwik::translate('Referrers_CampaignsReportDocumentation',
|
||||
array('<br />', '<a href="http://piwik.org/docs/tracking-campaigns/" target="_blank">', '</a>')),
|
||||
'actionToLoadSubTables' => 'getKeywordsFromCampaignId',
|
||||
'order' => 9,
|
||||
),
|
||||
array( // subtable report
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Campaigns'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getKeywordsFromCampaignId',
|
||||
'dimension' => Piwik::translate('General_ColumnKeyword'),
|
||||
'documentation' => Piwik::translate('Referrers_CampaignsReportDocumentation',
|
||||
array('<br />', '<a href="http://piwik.org/docs/tracking-campaigns/" target="_blank">', '</a>')),
|
||||
'isSubtableReport' => true,
|
||||
'order' => 10,
|
||||
),
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Socials'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getSocials',
|
||||
'actionToLoadSubTables' => 'getUrlsForSocial',
|
||||
'dimension' => Piwik::translate('Referrers_ColumnSocial'),
|
||||
'documentation' => Piwik::translate('Referrers_WebsitesReportDocumentation', '<br />'),
|
||||
'order' => 11,
|
||||
),
|
||||
array(
|
||||
'category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Socials'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getUrlsForSocial',
|
||||
'isSubtableReport' => true,
|
||||
'dimension' => Piwik::translate('Referrers_ColumnWebsitePage'),
|
||||
'documentation' => Piwik::translate('Referrers_WebsitesReportDocumentation', '<br />'),
|
||||
'order' => 12,
|
||||
),
|
||||
));
|
||||
}
|
||||
|
||||
public function getSegmentsMetadata(&$segments)
|
||||
{
|
||||
$segments[] = array(
|
||||
'type' => 'dimension',
|
||||
'category' => 'Referrers_Referrers',
|
||||
'name' => 'Referrers_Type',
|
||||
'segment' => 'referrerType',
|
||||
'acceptedValues' => 'direct, search, website, campaign',
|
||||
'sqlSegment' => 'log_visit.referer_type',
|
||||
'sqlFilterValue' => __NAMESPACE__ . '\getReferrerTypeFromShortName',
|
||||
);
|
||||
$segments[] = array(
|
||||
'type' => 'dimension',
|
||||
'category' => 'Referrers_Referrers',
|
||||
'name' => 'General_ColumnKeyword',
|
||||
'segment' => 'referrerKeyword',
|
||||
'acceptedValues' => 'Encoded%20Keyword, keyword',
|
||||
'sqlSegment' => 'log_visit.referer_keyword',
|
||||
);
|
||||
$segments[] = array(
|
||||
'type' => 'dimension',
|
||||
'category' => 'Referrers_Referrers',
|
||||
'name' => 'Referrers_ReferrerName',
|
||||
'segment' => 'referrerName',
|
||||
'acceptedValues' => 'twitter.com, www.facebook.com, Bing, Google, Yahoo, CampaignName',
|
||||
'sqlSegment' => 'log_visit.referer_name',
|
||||
);
|
||||
$segments[] = array(
|
||||
'type' => 'dimension',
|
||||
'category' => 'Referrers_Referrers',
|
||||
'name' => 'Live_Referrer_URL',
|
||||
'acceptedValues' => 'http%3A%2F%2Fwww.example.org%2Freferer-page.htm',
|
||||
'segment' => 'referrerUrl',
|
||||
'sqlSegment' => 'log_visit.referer_url',
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds Referrer widgets
|
||||
*/
|
||||
function addWidgets()
|
||||
{
|
||||
WidgetsList::add('Referrers_Referrers', 'Referrers_WidgetKeywords', 'Referrers', 'getKeywords');
|
||||
WidgetsList::add('Referrers_Referrers', 'Referrers_WidgetExternalWebsites', 'Referrers', 'getWebsites');
|
||||
WidgetsList::add('Referrers_Referrers', 'Referrers_WidgetSocials', 'Referrers', 'getSocials');
|
||||
WidgetsList::add('Referrers_Referrers', 'Referrers_SearchEngines', 'Referrers', 'getSearchEngines');
|
||||
WidgetsList::add('Referrers_Referrers', 'Referrers_Campaigns', 'Referrers', 'getCampaigns');
|
||||
WidgetsList::add('Referrers_Referrers', 'General_Overview', 'Referrers', 'getReferrerType');
|
||||
WidgetsList::add('Referrers_Referrers', 'Referrers_WidgetGetAll', 'Referrers', 'getAll');
|
||||
if (SettingsPiwik::isSegmentationEnabled()) {
|
||||
WidgetsList::add('SEO', 'Referrers_WidgetTopKeywordsForPages', 'Referrers', 'getKeywordsForPage');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds Web Analytics menus
|
||||
*/
|
||||
function addMenus()
|
||||
{
|
||||
MenuMain::getInstance()->add('Referrers_Referrers', '', array('module' => 'Referrers', 'action' => 'index'), true, 20);
|
||||
MenuMain::getInstance()->add('Referrers_Referrers', 'General_Overview', array('module' => 'Referrers', 'action' => 'index'), true, 1);
|
||||
MenuMain::getInstance()->add('Referrers_Referrers', 'Referrers_SubmenuSearchEngines', array('module' => 'Referrers', 'action' => 'getSearchEnginesAndKeywords'), true, 2);
|
||||
MenuMain::getInstance()->add('Referrers_Referrers', 'Referrers_SubmenuWebsites', array('module' => 'Referrers', 'action' => 'indexWebsites'), true, 3);
|
||||
MenuMain::getInstance()->add('Referrers_Referrers', 'Referrers_Campaigns', array('module' => 'Referrers', 'action' => 'indexCampaigns'), true, 4);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds Goal dimensions, so that the dimensions are displayed in the UI Goal Overview page
|
||||
*/
|
||||
public function getReportsWithGoalMetrics(&$dimensions)
|
||||
{
|
||||
$dimensions = array_merge($dimensions, array(
|
||||
array('category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Type'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getReferrerType',
|
||||
),
|
||||
array('category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Keywords'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getKeywords',
|
||||
),
|
||||
array('category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_SearchEngines'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getSearchEngines',
|
||||
),
|
||||
array('category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Websites'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getWebsites',
|
||||
),
|
||||
array('category' => Piwik::translate('Referrers_Referrers'),
|
||||
'name' => Piwik::translate('Referrers_Campaigns'),
|
||||
'module' => 'Referrers',
|
||||
'action' => 'getCampaigns',
|
||||
),
|
||||
));
|
||||
}
|
||||
|
||||
public function getDefaultTypeViewDataTable(&$defaultViewTypes)
|
||||
{
|
||||
$defaultViewTypes['Referrers.getReferrerType'] = AllColumns::ID;
|
||||
$defaultViewTypes['Referrers.getSocials'] = Pie::ID;
|
||||
}
|
||||
|
||||
public function configureViewDataTable(ViewDataTable $view)
|
||||
{
|
||||
switch ($view->requestConfig->apiMethodToRequestDataTable) {
|
||||
case 'Referrers.getReferrerType':
|
||||
$this->configureViewForGetReferrerType($view);
|
||||
break;
|
||||
case 'Referrers.getAll':
|
||||
$this->configureViewForGetAll($view);
|
||||
break;
|
||||
case 'Referrers.getKeywords':
|
||||
$this->configureViewForGetKeywords($view);
|
||||
break;
|
||||
case 'Referrers.getSearchEnginesFromKeywordId':
|
||||
$this->configureViewForGetSearchEnginesFromKeywordId($view);
|
||||
break;
|
||||
case 'Referrers.getSearchEngines':
|
||||
$this->configureViewForGetSearchEngines($view);
|
||||
break;
|
||||
case 'Referrers.getKeywordsFromSearchEngineId':
|
||||
$this->configureViewForGetKeywordsFromSearchEngineId($view);
|
||||
break;
|
||||
case 'Referrers.getWebsites':
|
||||
$this->configureViewForGetWebsites($view);
|
||||
break;
|
||||
case 'Referrers.getSocials':
|
||||
$this->configureViewForGetSocials($view);
|
||||
break;
|
||||
case 'Referrers.getUrlsForSocial':
|
||||
$this->configureViewForGetUrlsForSocial($view);
|
||||
break;
|
||||
case 'Referrers.getCampaigns':
|
||||
$this->configureViewForGetCampaigns($view);
|
||||
break;
|
||||
case 'Referrers.getKeywordsFromCampaignId':
|
||||
$this->configureViewForGetKeywordsFromCampaignId($view);
|
||||
break;
|
||||
case 'Referrers.getUrlsFromWebsiteId':
|
||||
$this->configureViewForGetUrlsFromWebsiteId($view);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetReferrerType(ViewDataTable $view)
|
||||
{
|
||||
$idSubtable = Common::getRequestVar('idSubtable', false);
|
||||
$labelColumnTitle = Piwik::translate('Referrers_Type');
|
||||
|
||||
switch ($idSubtable) {
|
||||
case Common::REFERRER_TYPE_SEARCH_ENGINE:
|
||||
$labelColumnTitle = Piwik::translate('Referrers_ColumnSearchEngine');
|
||||
break;
|
||||
case Common::REFERRER_TYPE_WEBSITE:
|
||||
$labelColumnTitle = Piwik::translate('Referrers_ColumnWebsite');
|
||||
break;
|
||||
case Common::REFERRER_TYPE_CAMPAIGN:
|
||||
$labelColumnTitle = Piwik::translate('Referrers_ColumnCampaign');
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
$view->config->show_search = false;
|
||||
$view->config->show_goals = true;
|
||||
$view->config->show_offset_information = false;
|
||||
$view->config->show_pagination_control = false;
|
||||
$view->config->show_limit_control = false;
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', $labelColumnTitle);
|
||||
|
||||
$view->requestConfig->filter_limit = 10;
|
||||
|
||||
if ($view->isViewDataTableId(HtmlTable::ID)) {
|
||||
$view->config->disable_subtable_when_show_goals = true;
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetAll(ViewDataTable $view)
|
||||
{
|
||||
$setGetAllHtmlPrefix = array($this, 'setGetAllHtmlPrefix');
|
||||
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->show_goals = true;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_Referrer'));
|
||||
|
||||
$view->requestConfig->filter_limit = 20;
|
||||
|
||||
if ($view->isViewDataTableId(HtmlTable::ID)) {
|
||||
$view->config->disable_row_actions = true;
|
||||
}
|
||||
|
||||
$view->config->filters[] = array('MetadataCallbackAddMetadata', array('referer_type', 'html_label_prefix', $setGetAllHtmlPrefix));
|
||||
}
|
||||
|
||||
private function configureViewForGetKeywords(ViewDataTable $view)
|
||||
{
|
||||
$view->config->subtable_controller_action = 'getSearchEnginesFromKeywordId';
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', Piwik::translate('General_ColumnKeyword'));
|
||||
$view->config->show_goals = true;
|
||||
|
||||
$view->requestConfig->filter_limit = 25;
|
||||
|
||||
if ($view->isViewDataTableId(HtmlTable::ID)) {
|
||||
$view->config->disable_subtable_when_show_goals = true;
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetSearchEnginesFromKeywordId(ViewDataTable $view)
|
||||
{
|
||||
$view->config->show_search = false;
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnSearchEngine'));
|
||||
}
|
||||
|
||||
private function configureViewForGetSearchEngines(ViewDataTable $view)
|
||||
{
|
||||
$view->config->subtable_controller_action = 'getKeywordsFromSearchEngineId';
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->show_search = false;
|
||||
$view->config->show_goals = true;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnSearchEngine'));
|
||||
|
||||
$view->requestConfig->filter_limit = 25;
|
||||
|
||||
if ($view->isViewDataTableId(HtmlTable::ID)) {
|
||||
$view->config->disable_subtable_when_show_goals = true;
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetKeywordsFromSearchEngineId(ViewDataTable $view)
|
||||
{
|
||||
$view->config->show_search = false;
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', Piwik::translate('General_ColumnKeyword'));
|
||||
}
|
||||
|
||||
private function configureViewForGetWebsites(ViewDataTable $view)
|
||||
{
|
||||
$view->config->subtable_controller_action = 'getUrlsFromWebsiteId';
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->show_goals = true;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnWebsite'));
|
||||
|
||||
$view->requestConfig->filter_limit = 25;
|
||||
|
||||
if ($view->isViewDataTableId(HtmlTable::ID)) {
|
||||
$view->config->disable_subtable_when_show_goals = true;
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetSocials(ViewDataTable $view)
|
||||
{
|
||||
$view->config->subtable_controller_action = 'getUrlsForSocial';
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->show_goals = true;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnSocial'));
|
||||
|
||||
$view->requestConfig->filter_limit = 10;
|
||||
|
||||
if ($view->isViewDataTableId(HtmlTable::ID)) {
|
||||
$view->config->disable_subtable_when_show_goals = true;
|
||||
}
|
||||
|
||||
$widget = Common::getRequestVar('widget', false);
|
||||
if (empty($widget)) {
|
||||
$view->config->show_footer_message = Piwik::translate('Referrers_SocialFooterMessage');
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetUrlsForSocial(ViewDataTable $view)
|
||||
{
|
||||
$view->config->show_goals = true;
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnWebsitePage'));
|
||||
|
||||
$view->requestConfig->filter_limit = 10;
|
||||
}
|
||||
|
||||
private function configureViewForGetCampaigns(ViewDataTable $view)
|
||||
{
|
||||
$view->config->show_goals = true;
|
||||
$view->config->subtable_controller_action = 'getKeywordsFromCampaignId';
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnCampaign'));
|
||||
|
||||
$view->requestConfig->filter_limit = 25;
|
||||
|
||||
if (Common::getRequestVar('viewDataTable', false) != 'graphEvolution') {
|
||||
$view->config->show_footer_message = Piwik::translate('Referrers_CampaignFooterHelp',
|
||||
array('<a target="_blank" href="http://piwik.org/docs/tracking-campaigns/">',
|
||||
'</a> - <a target="_blank" href="http://piwik.org/docs/tracking-campaigns/url-builder/">',
|
||||
'</a>')
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private function configureViewForGetKeywordsFromCampaignId(ViewDataTable $view)
|
||||
{
|
||||
$view->config->show_search = false;
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->addTranslation('label', Piwik::translate('General_ColumnKeyword'));
|
||||
}
|
||||
|
||||
private function configureViewForGetUrlsFromWebsiteId(ViewDataTable $view)
|
||||
{
|
||||
$view->config->show_search = false;
|
||||
$view->config->show_exclude_low_population = false;
|
||||
$view->config->tooltip_metadata_name = 'url';
|
||||
$view->config->addTranslation('label', Piwik::translate('Referrers_ColumnWebsitePage'));
|
||||
}
|
||||
|
||||
/**
|
||||
* DataTable filter callback that returns the HTML prefix for a label in the
|
||||
* 'getAll' report based on the row's referrer type.
|
||||
*
|
||||
* @param int $referrerType The referrer type.
|
||||
* @return string
|
||||
*/
|
||||
public function setGetAllHtmlPrefix($referrerType)
|
||||
{
|
||||
// get singular label for referrer type
|
||||
$indexTranslation = '';
|
||||
switch ($referrerType) {
|
||||
case Common::REFERRER_TYPE_DIRECT_ENTRY:
|
||||
$indexTranslation = 'Referrers_DirectEntry';
|
||||
break;
|
||||
case Common::REFERRER_TYPE_SEARCH_ENGINE:
|
||||
$indexTranslation = 'General_ColumnKeyword';
|
||||
break;
|
||||
case Common::REFERRER_TYPE_WEBSITE:
|
||||
$indexTranslation = 'Referrers_ColumnWebsite';
|
||||
break;
|
||||
case Common::REFERRER_TYPE_CAMPAIGN:
|
||||
$indexTranslation = 'Referrers_ColumnCampaign';
|
||||
break;
|
||||
default:
|
||||
// case of newsletter, partners, before Piwik 0.2.25
|
||||
$indexTranslation = 'General_Others';
|
||||
break;
|
||||
}
|
||||
|
||||
$label = strtolower(Piwik::translate($indexTranslation));
|
||||
|
||||
// return html that displays it as grey & italic
|
||||
return '<span class="datatable-label-category"><em>(' . $label . ')</em></span>';
|
||||
}
|
||||
}
|
||||
283
www/analytics/plugins/Referrers/functions.php
Normal file
283
www/analytics/plugins/Referrers/functions.php
Normal file
|
|
@ -0,0 +1,283 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\Plugins\Referrers;
|
||||
|
||||
use Piwik\Common;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\UrlHelper;
|
||||
|
||||
/**
|
||||
* Returns path component from a URL
|
||||
*
|
||||
* @param string $url
|
||||
* @return string path
|
||||
*/
|
||||
function getPathFromUrl($url)
|
||||
{
|
||||
$path = UrlHelper::getPathAndQueryFromUrl($url);
|
||||
if (empty($path)) {
|
||||
return 'index';
|
||||
}
|
||||
return $path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the main url of the social network the given url matches
|
||||
*
|
||||
* @param string $url
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
function getSocialMainUrl($url)
|
||||
{
|
||||
$social = getSocialNetworkFromDomain($url);
|
||||
foreach (Common::getSocialUrls() AS $domain => $name) {
|
||||
|
||||
if($name == $social) {
|
||||
|
||||
return $domain;
|
||||
}
|
||||
}
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get's social network name from URL.
|
||||
*
|
||||
* @param string $url
|
||||
* @return string
|
||||
*/
|
||||
function getSocialNetworkFromDomain($url)
|
||||
{
|
||||
foreach (Common::getSocialUrls() AS $domain => $name) {
|
||||
|
||||
if(preg_match('/(^|[\.\/])'.$domain.'([\.\/]|$)/', $url)) {
|
||||
|
||||
return $name;
|
||||
}
|
||||
}
|
||||
|
||||
return Piwik::translate('General_Unknown');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if a URL belongs to a social network, false if otherwise.
|
||||
*
|
||||
* @param string $url The URL to check.
|
||||
* @param string|bool $socialName The social network's name to check for, or false to check
|
||||
* for any.
|
||||
* @return bool
|
||||
*/
|
||||
function isSocialUrl($url, $socialName = false)
|
||||
{
|
||||
foreach (Common::getSocialUrls() AS $domain => $name) {
|
||||
|
||||
if (preg_match('/(^|[\.\/])'.$domain.'([\.\/]|$)/', $url) && ($socialName === false || $name == $socialName)) {
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return social network logo path by URL
|
||||
*
|
||||
* @param string $domain
|
||||
* @return string path
|
||||
* @see plugins/Referrers/images/socials/
|
||||
*/
|
||||
function getSocialsLogoFromUrl($domain)
|
||||
{
|
||||
$social = getSocialNetworkFromDomain($domain);
|
||||
$socialNetworks = Common::getSocialUrls();
|
||||
|
||||
$filePattern = 'plugins/Referrers/images/socials/%s.png';
|
||||
|
||||
foreach ($socialNetworks as $domainKey => $name) {
|
||||
if ($social == $socialNetworks[$domainKey] && file_exists(PIWIK_INCLUDE_PATH . '/' . sprintf($filePattern, $domainKey))) {
|
||||
return sprintf($filePattern, $domainKey);
|
||||
}
|
||||
}
|
||||
|
||||
return sprintf($filePattern, 'xx');
|
||||
}
|
||||
|
||||
/**
|
||||
* Return search engine URL by name
|
||||
*
|
||||
* @see core/DataFiles/SearchEnginges.php
|
||||
*
|
||||
* @param string $name
|
||||
* @return string URL
|
||||
*/
|
||||
function getSearchEngineUrlFromName($name)
|
||||
{
|
||||
$searchEngineNames = Common::getSearchEngineNames();
|
||||
if (isset($searchEngineNames[$name])) {
|
||||
$url = 'http://' . $searchEngineNames[$name];
|
||||
} else {
|
||||
$url = 'URL unknown!';
|
||||
}
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return search engine host in URL
|
||||
*
|
||||
* @param string $url
|
||||
* @return string host
|
||||
*/
|
||||
function getSearchEngineHostFromUrl($url)
|
||||
{
|
||||
if (strpos($url, '//')) {
|
||||
$url = substr($url, strpos($url, '//') + 2);
|
||||
}
|
||||
if (($p = strpos($url, '/')) !== false) {
|
||||
$url = substr($url, 0, $p);
|
||||
}
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return search engine logo path by URL
|
||||
*
|
||||
* @param string $url
|
||||
* @return string path
|
||||
* @see plugins/Referrers/images/searchEnginges/
|
||||
*/
|
||||
function getSearchEngineLogoFromUrl($url)
|
||||
{
|
||||
$pathInPiwik = 'plugins/Referrers/images/searchEngines/%s.png';
|
||||
$pathWithCode = sprintf($pathInPiwik, getSearchEngineHostFromUrl($url));
|
||||
$absolutePath = PIWIK_INCLUDE_PATH . '/' . $pathWithCode;
|
||||
if (file_exists($absolutePath)) {
|
||||
return $pathWithCode;
|
||||
}
|
||||
return sprintf($pathInPiwik, 'xx');
|
||||
}
|
||||
|
||||
/**
|
||||
* Return search engine host and path in URL
|
||||
*
|
||||
* @param string $url
|
||||
* @return string host
|
||||
*/
|
||||
function getSearchEngineHostPathFromUrl($url)
|
||||
{
|
||||
$url = substr($url, strpos($url, '//') + 2);
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return search engine URL for URL and keyword
|
||||
*
|
||||
* @see core/DataFiles/SearchEnginges.php
|
||||
*
|
||||
* @param string $url Domain name, e.g., search.piwik.org
|
||||
* @param string $keyword Keyword, e.g., web+analytics
|
||||
* @return string URL, e.g., http://search.piwik.org/q=web+analytics
|
||||
*/
|
||||
function getSearchEngineUrlFromUrlAndKeyword($url, $keyword)
|
||||
{
|
||||
if ($keyword === API::LABEL_KEYWORD_NOT_DEFINED) {
|
||||
return 'http://piwik.org/faq/general/#faq_144';
|
||||
}
|
||||
$searchEngineUrls = Common::getSearchEngineUrls();
|
||||
$keyword = urlencode($keyword);
|
||||
$keyword = str_replace(urlencode('+'), urlencode(' '), $keyword);
|
||||
$path = @$searchEngineUrls[getSearchEngineHostPathFromUrl($url)][2];
|
||||
if (empty($path)) {
|
||||
return false;
|
||||
}
|
||||
$path = str_replace("{k}", $keyword, $path);
|
||||
return $url . (substr($url, -1) != '/' ? '/' : '') . $path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return search engine URL for keyword and URL
|
||||
*
|
||||
* @see \Piwik\Plugins\Referrers\getSearchEngineUrlFromUrlAndKeyword
|
||||
*
|
||||
* @param string $keyword Keyword, e.g., web+analytics
|
||||
* @param string $url Domain name, e.g., search.piwik.org
|
||||
* @return string URL, e.g., http://search.piwik.org/q=web+analytics
|
||||
*/
|
||||
function getSearchEngineUrlFromKeywordAndUrl($keyword, $url)
|
||||
{
|
||||
return getSearchEngineUrlFromUrlAndKeyword($url, $keyword);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return translated referrer type
|
||||
*
|
||||
* @param string $label
|
||||
* @return string Referrer type
|
||||
*/
|
||||
function getReferrerTypeLabel($label)
|
||||
{
|
||||
$indexTranslation = '';
|
||||
switch ($label) {
|
||||
case Common::REFERRER_TYPE_DIRECT_ENTRY:
|
||||
$indexTranslation = 'Referrers_DirectEntry';
|
||||
break;
|
||||
case Common::REFERRER_TYPE_SEARCH_ENGINE:
|
||||
$indexTranslation = 'Referrers_SearchEngines';
|
||||
break;
|
||||
case Common::REFERRER_TYPE_WEBSITE:
|
||||
$indexTranslation = 'Referrers_Websites';
|
||||
break;
|
||||
case Common::REFERRER_TYPE_CAMPAIGN:
|
||||
$indexTranslation = 'Referrers_Campaigns';
|
||||
break;
|
||||
default:
|
||||
// case of newsletter, partners, before Piwik 0.2.25
|
||||
$indexTranslation = 'General_Others';
|
||||
break;
|
||||
}
|
||||
return Piwik::translate($indexTranslation);
|
||||
}
|
||||
|
||||
/**
|
||||
* Works in both directions
|
||||
* @param string $name
|
||||
* @throws \Exception
|
||||
* @return string
|
||||
*/
|
||||
function getReferrerTypeFromShortName($name)
|
||||
{
|
||||
$map = array(
|
||||
Common::REFERRER_TYPE_SEARCH_ENGINE => 'search',
|
||||
Common::REFERRER_TYPE_WEBSITE => 'website',
|
||||
Common::REFERRER_TYPE_DIRECT_ENTRY => 'direct',
|
||||
Common::REFERRER_TYPE_CAMPAIGN => 'campaign',
|
||||
);
|
||||
if (isset($map[$name])) {
|
||||
return $map[$name];
|
||||
}
|
||||
if ($found = array_search($name, $map)) {
|
||||
return $found;
|
||||
}
|
||||
throw new \Exception("Referrer type '$name' is not valid.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a URL w/o the protocol type.
|
||||
*
|
||||
* @param string $url
|
||||
* @return string
|
||||
*/
|
||||
function removeUrlProtocol($url)
|
||||
{
|
||||
if (preg_match('/^[a-zA-Z_-]+:\/\//', $url, $matches)) {
|
||||
return substr($url, strlen($matches[0]));
|
||||
}
|
||||
return $url;
|
||||
}
|
||||
BIN
www/analytics/plugins/Referrers/images/searchEngines/1.cz.png
Normal file
BIN
www/analytics/plugins/Referrers/images/searchEngines/1.cz.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 736 B |
Binary file not shown.
|
After Width: | Height: | Size: 734 B |
Binary file not shown.
|
After Width: | Height: | Size: 878 B |
BIN
www/analytics/plugins/Referrers/images/searchEngines/all.by.png
Normal file
BIN
www/analytics/plugins/Referrers/images/searchEngines/all.by.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 736 B |
Binary file not shown.
|
After Width: | Height: | Size: 664 B |
Binary file not shown.
|
After Width: | Height: | Size: 477 B |
Binary file not shown.
|
After Width: | Height: | Size: 736 B |
Binary file not shown.
|
After Width: | Height: | Size: 272 B |
Binary file not shown.
|
After Width: | Height: | Size: 763 B |
BIN
www/analytics/plugins/Referrers/images/searchEngines/ask.com.png
Normal file
BIN
www/analytics/plugins/Referrers/images/searchEngines/ask.com.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 587 B |
Binary file not shown.
|
After Width: | Height: | Size: 493 B |
Binary file not shown.
|
After Width: | Height: | Size: 590 B |
Binary file not shown.
|
After Width: | Height: | Size: 174 B |
Binary file not shown.
|
After Width: | Height: | Size: 461 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
Binary file not shown.
|
After Width: | Height: | Size: 430 B |
Binary file not shown.
|
After Width: | Height: | Size: 701 B |
Binary file not shown.
|
After Width: | Height: | Size: 869 B |
Binary file not shown.
|
After Width: | Height: | Size: 716 B |
Binary file not shown.
|
After Width: | Height: | Size: 564 B |
Binary file not shown.
|
After Width: | Height: | Size: 718 B |
Binary file not shown.
|
After Width: | Height: | Size: 465 B |
Binary file not shown.
|
After Width: | Height: | Size: 846 B |
Binary file not shown.
|
After Width: | Height: | Size: 732 B |
Binary file not shown.
|
After Width: | Height: | Size: 900 B |
Binary file not shown.
|
After Width: | Height: | Size: 667 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
BIN
www/analytics/plugins/Referrers/images/searchEngines/eo.st.png
Normal file
BIN
www/analytics/plugins/Referrers/images/searchEngines/eo.st.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 445 B |
Binary file not shown.
|
After Width: | Height: | Size: 814 B |
Binary file not shown.
|
After Width: | Height: | Size: 735 B |
Binary file not shown.
|
After Width: | Height: | Size: 490 B |
Binary file not shown.
|
After Width: | Height: | Size: 524 B |
Binary file not shown.
|
After Width: | Height: | Size: 736 B |
Binary file not shown.
|
After Width: | Height: | Size: 3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 409 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
Binary file not shown.
|
After Width: | Height: | Size: 774 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
Binary file not shown.
|
After Width: | Height: | Size: 538 B |
Binary file not shown.
|
After Width: | Height: | Size: 497 B |
Binary file not shown.
|
After Width: | Height: | Size: 940 B |
Binary file not shown.
|
After Width: | Height: | Size: 587 B |
Binary file not shown.
|
After Width: | Height: | Size: 613 B |
Binary file not shown.
|
After Width: | Height: | Size: 580 B |
Binary file not shown.
|
After Width: | Height: | Size: 401 B |
Binary file not shown.
|
After Width: | Height: | Size: 736 B |
BIN
www/analytics/plugins/Referrers/images/searchEngines/lo.st.png
Normal file
BIN
www/analytics/plugins/Referrers/images/searchEngines/lo.st.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 828 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 281 B |
BIN
www/analytics/plugins/Referrers/images/searchEngines/meta.ua.png
Normal file
BIN
www/analytics/plugins/Referrers/images/searchEngines/meta.ua.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 873 B |
Binary file not shown.
|
After Width: | Height: | Size: 556 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
Binary file not shown.
|
After Width: | Height: | Size: 673 B |
Binary file not shown.
|
After Width: | Height: | Size: 765 B |
Binary file not shown.
|
After Width: | Height: | Size: 591 B |
Binary file not shown.
|
After Width: | Height: | Size: 543 B |
Binary file not shown.
|
After Width: | Height: | Size: 869 B |
Binary file not shown.
|
After Width: | Height: | Size: 838 B |
Binary file not shown.
|
After Width: | Height: | Size: 718 B |
Binary file not shown.
|
After Width: | Height: | Size: 719 B |
Binary file not shown.
|
After Width: | Height: | Size: 275 B |
Binary file not shown.
|
After Width: | Height: | Size: 706 B |
Binary file not shown.
|
After Width: | Height: | Size: 755 B |
Binary file not shown.
|
After Width: | Height: | Size: 275 B |
Binary file not shown.
|
After Width: | Height: | Size: 333 B |
Binary file not shown.
|
After Width: | Height: | Size: 867 B |
Binary file not shown.
|
After Width: | Height: | Size: 368 B |
Binary file not shown.
|
After Width: | Height: | Size: 545 B |
Binary file not shown.
|
After Width: | Height: | Size: 706 B |
Binary file not shown.
|
After Width: | Height: | Size: 713 B |
Binary file not shown.
|
After Width: | Height: | Size: 930 B |
Binary file not shown.
|
After Width: | Height: | Size: 349 B |
Binary file not shown.
|
After Width: | Height: | Size: 599 B |
Binary file not shown.
|
After Width: | Height: | Size: 839 B |
Binary file not shown.
|
After Width: | Height: | Size: 617 B |
Binary file not shown.
|
After Width: | Height: | Size: 800 B |
Binary file not shown.
|
After Width: | Height: | Size: 564 B |
Binary file not shown.
|
After Width: | Height: | Size: 323 B |
Binary file not shown.
|
After Width: | Height: | Size: 881 B |
Binary file not shown.
|
After Width: | Height: | Size: 951 B |
Binary file not shown.
|
After Width: | Height: | Size: 730 B |
Binary file not shown.
|
After Width: | Height: | Size: 644 B |
Binary file not shown.
|
After Width: | Height: | Size: 331 B |
Binary file not shown.
|
After Width: | Height: | Size: 367 B |
Binary file not shown.
|
After Width: | Height: | Size: 670 B |
Binary file not shown.
|
After Width: | Height: | Size: 317 B |
Binary file not shown.
|
After Width: | Height: | Size: 565 B |
Binary file not shown.
|
After Width: | Height: | Size: 832 B |
Binary file not shown.
|
After Width: | Height: | Size: 556 B |
Binary file not shown.
|
After Width: | Height: | Size: 794 B |
Binary file not shown.
|
After Width: | Height: | Size: 553 B |
Binary file not shown.
|
After Width: | Height: | Size: 624 B |
Binary file not shown.
|
After Width: | Height: | Size: 570 B |
Binary file not shown.
|
After Width: | Height: | Size: 716 B |
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue