restructure application classes
This commit is contained in:
coderkun
commit
a6d9bf653a
3471 changed files with 597952 additions and 0 deletions
992
www/analytics/plugins/Live/Visitor.php
Normal file
992
www/analytics/plugins/Live/Visitor.php
Normal file
|
|
@ -0,0 +1,992 @@
|
|||
<?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\Live;
|
||||
|
||||
use Piwik\Common;
|
||||
use Piwik\DataAccess\LogAggregator;
|
||||
use Piwik\DataTable\Filter\ColumnDelete;
|
||||
use Piwik\Date;
|
||||
use Piwik\Db;
|
||||
use Piwik\IP;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\Plugins\API\API as APIMetadata;
|
||||
use Piwik\Plugins\CustomVariables\CustomVariables;
|
||||
use Piwik\Plugins\Referrers\API as APIReferrers;
|
||||
use Piwik\Plugins\UserCountry\LocationProvider\GeoIp;
|
||||
use Piwik\Tracker\Action;
|
||||
use Piwik\Tracker\GoalManager;
|
||||
use Piwik\Tracker;
|
||||
use Piwik\Tracker\Visit;
|
||||
use Piwik\UrlHelper;
|
||||
|
||||
/**
|
||||
* @see plugins/Referrers/functions.php
|
||||
* @see plugins/UserCountry/functions.php
|
||||
* @see plugins/UserSettings/functions.php
|
||||
* @see plugins/Provider/functions.php
|
||||
*/
|
||||
|
||||
require_once PIWIK_INCLUDE_PATH . '/plugins/Referrers/functions.php';
|
||||
require_once PIWIK_INCLUDE_PATH . '/plugins/UserCountry/functions.php';
|
||||
require_once PIWIK_INCLUDE_PATH . '/plugins/UserSettings/functions.php';
|
||||
require_once PIWIK_INCLUDE_PATH . '/plugins/Provider/functions.php';
|
||||
|
||||
/**
|
||||
*/
|
||||
class Visitor
|
||||
{
|
||||
const DELIMITER_PLUGIN_NAME = ", ";
|
||||
|
||||
const EVENT_VALUE_PRECISION = 3;
|
||||
|
||||
function __construct($visitorRawData)
|
||||
{
|
||||
$this->details = $visitorRawData;
|
||||
}
|
||||
|
||||
function getAllVisitorDetails()
|
||||
{
|
||||
return array(
|
||||
'idSite' => $this->getIdSite(),
|
||||
'idVisit' => $this->getIdVisit(),
|
||||
'visitIp' => $this->getIp(),
|
||||
'visitorId' => $this->getVisitorId(),
|
||||
'visitorType' => $this->getVisitorReturning(),
|
||||
'visitorTypeIcon' => $this->getVisitorReturningIcon(),
|
||||
'visitConverted' => $this->isVisitorGoalConverted(),
|
||||
'visitConvertedIcon' => $this->getVisitorGoalConvertedIcon(),
|
||||
'visitEcommerceStatus' => $this->getVisitEcommerceStatus(),
|
||||
'visitEcommerceStatusIcon' => $this->getVisitEcommerceStatusIcon(),
|
||||
|
||||
'searches' => $this->getNumberOfSearches(),
|
||||
'events' => $this->getNumberOfEvents(),
|
||||
'actions' => $this->getNumberOfActions(),
|
||||
// => false are placeholders to be filled in API later
|
||||
'actionDetails' => false,
|
||||
'customVariables' => $this->getCustomVariables(),
|
||||
'goalConversions' => false,
|
||||
'siteCurrency' => false,
|
||||
'siteCurrencySymbol' => false,
|
||||
|
||||
// all time entries
|
||||
'serverDate' => $this->getServerDate(),
|
||||
'visitLocalTime' => $this->getVisitLocalTime(),
|
||||
'visitLocalHour' => $this->getVisitLocalHour(),
|
||||
'visitServerHour' => $this->getVisitServerHour(),
|
||||
'firstActionTimestamp' => $this->getTimestampFirstAction(),
|
||||
'lastActionTimestamp' => $this->getTimestampLastAction(),
|
||||
'lastActionDateTime' => $this->getDateTimeLastAction(),
|
||||
|
||||
// standard attributes
|
||||
'visitDuration' => $this->getVisitLength(),
|
||||
'visitDurationPretty' => $this->getVisitLengthPretty(),
|
||||
'visitCount' => $this->getVisitCount(),
|
||||
'daysSinceLastVisit' => $this->getDaysSinceLastVisit(),
|
||||
'daysSinceFirstVisit' => $this->getDaysSinceFirstVisit(),
|
||||
'daysSinceLastEcommerceOrder' => $this->getDaysSinceLastEcommerceOrder(),
|
||||
'continent' => $this->getContinent(),
|
||||
'continentCode' => $this->getContinentCode(),
|
||||
'country' => $this->getCountryName(),
|
||||
'countryCode' => $this->getCountryCode(),
|
||||
'countryFlag' => $this->getCountryFlag(),
|
||||
'region' => $this->getRegionName(),
|
||||
'regionCode' => $this->getRegionCode(),
|
||||
'city' => $this->getCityName(),
|
||||
'location' => $this->getPrettyLocation(),
|
||||
'latitude' => $this->getLatitude(),
|
||||
'longitude' => $this->getLongitude(),
|
||||
'provider' => $this->getProvider(),
|
||||
'providerName' => $this->getProviderName(),
|
||||
'providerUrl' => $this->getProviderUrl(),
|
||||
|
||||
'referrerType' => $this->getReferrerType(),
|
||||
'referrerTypeName' => $this->getReferrerTypeName(),
|
||||
'referrerName' => $this->getReferrerName(),
|
||||
'referrerKeyword' => $this->getKeyword(),
|
||||
'referrerKeywordPosition' => $this->getKeywordPosition(),
|
||||
'referrerUrl' => $this->getReferrerUrl(),
|
||||
'referrerSearchEngineUrl' => $this->getSearchEngineUrl(),
|
||||
'referrerSearchEngineIcon' => $this->getSearchEngineIcon(),
|
||||
'operatingSystem' => $this->getOperatingSystem(),
|
||||
'operatingSystemCode' => $this->getOperatingSystemCode(),
|
||||
'operatingSystemShortName' => $this->getOperatingSystemShortName(),
|
||||
'operatingSystemIcon' => $this->getOperatingSystemIcon(),
|
||||
'browserFamily' => $this->getBrowserFamily(),
|
||||
'browserFamilyDescription' => $this->getBrowserFamilyDescription(),
|
||||
'browserName' => $this->getBrowser(),
|
||||
'browserIcon' => $this->getBrowserIcon(),
|
||||
'browserCode' => $this->getBrowserCode(),
|
||||
'browserVersion' => $this->getBrowserVersion(),
|
||||
'screenType' => $this->getScreenType(),
|
||||
'deviceType' => $this->getDeviceType(),
|
||||
'resolution' => $this->getResolution(),
|
||||
'screenTypeIcon' => $this->getScreenTypeIcon(),
|
||||
'plugins' => $this->getPlugins(),
|
||||
'pluginsIcons' => $this->getPluginIcons(),
|
||||
);
|
||||
}
|
||||
|
||||
function getVisitorId()
|
||||
{
|
||||
if (isset($this->details['idvisitor'])) {
|
||||
return bin2hex($this->details['idvisitor']);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function getVisitLocalTime()
|
||||
{
|
||||
return $this->details['visitor_localtime'];
|
||||
}
|
||||
|
||||
function getVisitServerHour()
|
||||
{
|
||||
return date('G', strtotime($this->details['visit_last_action_time']));
|
||||
}
|
||||
|
||||
function getVisitLocalHour()
|
||||
{
|
||||
return date('G', strtotime('2012-12-21 ' . $this->details['visitor_localtime']));
|
||||
}
|
||||
|
||||
function getVisitCount()
|
||||
{
|
||||
return $this->details['visitor_count_visits'];
|
||||
}
|
||||
|
||||
function getDaysSinceLastVisit()
|
||||
{
|
||||
return $this->details['visitor_days_since_last'];
|
||||
}
|
||||
|
||||
function getDaysSinceLastEcommerceOrder()
|
||||
{
|
||||
return $this->details['visitor_days_since_order'];
|
||||
}
|
||||
|
||||
function getDaysSinceFirstVisit()
|
||||
{
|
||||
return $this->details['visitor_days_since_first'];
|
||||
}
|
||||
|
||||
function getServerDate()
|
||||
{
|
||||
return date('Y-m-d', strtotime($this->details['visit_last_action_time']));
|
||||
}
|
||||
|
||||
function getIp()
|
||||
{
|
||||
if (isset($this->details['location_ip'])) {
|
||||
return IP::N2P($this->details['location_ip']);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function getIdVisit()
|
||||
{
|
||||
return $this->details['idvisit'];
|
||||
}
|
||||
|
||||
function getIdSite()
|
||||
{
|
||||
return $this->details['idsite'];
|
||||
}
|
||||
|
||||
function getNumberOfActions()
|
||||
{
|
||||
return $this->details['visit_total_actions'];
|
||||
}
|
||||
|
||||
function getNumberOfEvents()
|
||||
{
|
||||
return $this->details['visit_total_events'];
|
||||
}
|
||||
|
||||
function getNumberOfSearches()
|
||||
{
|
||||
return $this->details['visit_total_searches'];
|
||||
}
|
||||
|
||||
function getVisitLength()
|
||||
{
|
||||
return $this->details['visit_total_time'];
|
||||
}
|
||||
|
||||
function getVisitLengthPretty()
|
||||
{
|
||||
return \Piwik\MetricsFormatter::getPrettyTimeFromSeconds($this->details['visit_total_time']);
|
||||
}
|
||||
|
||||
function getVisitorReturning()
|
||||
{
|
||||
$type = $this->details['visitor_returning'];
|
||||
return $type == 2
|
||||
? 'returningCustomer'
|
||||
: ($type == 1
|
||||
? 'returning'
|
||||
: 'new');
|
||||
}
|
||||
|
||||
function getVisitorReturningIcon()
|
||||
{
|
||||
$type = $this->getVisitorReturning();
|
||||
if ($type == 'returning'
|
||||
|| $type == 'returningCustomer'
|
||||
) {
|
||||
return "plugins/Live/images/returningVisitor.gif";
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getTimestampFirstAction()
|
||||
{
|
||||
return strtotime($this->details['visit_first_action_time']);
|
||||
}
|
||||
|
||||
function getTimestampLastAction()
|
||||
{
|
||||
return strtotime($this->details['visit_last_action_time']);
|
||||
}
|
||||
|
||||
function getCountryCode()
|
||||
{
|
||||
return $this->details['location_country'];
|
||||
}
|
||||
|
||||
function getCountryName()
|
||||
{
|
||||
return \Piwik\Plugins\UserCountry\countryTranslate($this->getCountryCode());
|
||||
}
|
||||
|
||||
function getCountryFlag()
|
||||
{
|
||||
return \Piwik\Plugins\UserCountry\getFlagFromCode($this->getCountryCode());
|
||||
}
|
||||
|
||||
function getContinent()
|
||||
{
|
||||
return \Piwik\Plugins\UserCountry\continentTranslate($this->getContinentCode());
|
||||
}
|
||||
|
||||
function getContinentCode()
|
||||
{
|
||||
return Common::getContinent($this->details['location_country']);
|
||||
}
|
||||
|
||||
function getCityName()
|
||||
{
|
||||
if (!empty($this->details['location_city'])) {
|
||||
return $this->details['location_city'];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
public function getRegionName()
|
||||
{
|
||||
$region = $this->getRegionCode();
|
||||
if ($region != '' && $region != Visit::UNKNOWN_CODE) {
|
||||
return GeoIp::getRegionNameFromCodes(
|
||||
$this->details['location_country'], $region);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
public function getRegionCode()
|
||||
{
|
||||
return $this->details['location_region'];
|
||||
}
|
||||
|
||||
function getPrettyLocation()
|
||||
{
|
||||
$parts = array();
|
||||
|
||||
$city = $this->getCityName();
|
||||
if (!empty($city)) {
|
||||
$parts[] = $city;
|
||||
}
|
||||
$region = $this->getRegionName();
|
||||
if (!empty($region)) {
|
||||
$parts[] = $region;
|
||||
}
|
||||
|
||||
// add country & return concatenated result
|
||||
$parts[] = $this->getCountryName();
|
||||
return implode(', ', $parts);
|
||||
}
|
||||
|
||||
function getLatitude()
|
||||
{
|
||||
if (!empty($this->details['location_latitude'])) {
|
||||
return $this->details['location_latitude'];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getLongitude()
|
||||
{
|
||||
if (!empty($this->details['location_longitude'])) {
|
||||
return $this->details['location_longitude'];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getCustomVariables()
|
||||
{
|
||||
$customVariables = array();
|
||||
|
||||
$maxCustomVariables = CustomVariables::getMaxCustomVariables();
|
||||
|
||||
for ($i = 1; $i <= $maxCustomVariables; $i++) {
|
||||
if (!empty($this->details['custom_var_k' . $i])) {
|
||||
$customVariables[$i] = array(
|
||||
'customVariableName' . $i => $this->details['custom_var_k' . $i],
|
||||
'customVariableValue' . $i => $this->details['custom_var_v' . $i],
|
||||
);
|
||||
}
|
||||
}
|
||||
return $customVariables;
|
||||
}
|
||||
|
||||
function getReferrerType()
|
||||
{
|
||||
return \Piwik\Plugins\Referrers\getReferrerTypeFromShortName($this->details['referer_type']);
|
||||
}
|
||||
|
||||
function getReferrerTypeName()
|
||||
{
|
||||
return \Piwik\Plugins\Referrers\getReferrerTypeLabel($this->details['referer_type']);
|
||||
}
|
||||
|
||||
function getKeyword()
|
||||
{
|
||||
$keyword = $this->details['referer_keyword'];
|
||||
if (\Piwik\Plugin\Manager::getInstance()->isPluginActivated('Referrers')
|
||||
&& $this->getReferrerType() == 'search'
|
||||
) {
|
||||
$keyword = \Piwik\Plugins\Referrers\API::getCleanKeyword($keyword);
|
||||
}
|
||||
return urldecode($keyword);
|
||||
}
|
||||
|
||||
function getReferrerUrl()
|
||||
{
|
||||
if ($this->getReferrerType() == 'search') {
|
||||
if (\Piwik\Plugin\Manager::getInstance()->isPluginActivated('Referrers')
|
||||
&& $this->details['referer_keyword'] == APIReferrers::LABEL_KEYWORD_NOT_DEFINED
|
||||
) {
|
||||
return 'http://piwik.org/faq/general/#faq_144';
|
||||
} // Case URL is google.XX/url.... then we rewrite to the search result page url
|
||||
elseif ($this->getReferrerName() == 'Google'
|
||||
&& strpos($this->details['referer_url'], '/url')
|
||||
) {
|
||||
$refUrl = @parse_url($this->details['referer_url']);
|
||||
if (isset($refUrl['host'])) {
|
||||
$url = \Piwik\Plugins\Referrers\getSearchEngineUrlFromUrlAndKeyword('http://google.com', $this->getKeyword());
|
||||
$url = str_replace('google.com', $refUrl['host'], $url);
|
||||
return $url;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (\Piwik\UrlHelper::isLookLikeUrl($this->details['referer_url'])) {
|
||||
return $this->details['referer_url'];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getKeywordPosition()
|
||||
{
|
||||
if ($this->getReferrerType() == 'search'
|
||||
&& strpos($this->getReferrerName(), 'Google') !== false
|
||||
) {
|
||||
$url = @parse_url($this->details['referer_url']);
|
||||
if (empty($url['query'])) {
|
||||
return null;
|
||||
}
|
||||
$position = UrlHelper::getParameterFromQueryString($url['query'], 'cd');
|
||||
if (!empty($position)) {
|
||||
return $position;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getReferrerName()
|
||||
{
|
||||
return urldecode($this->details['referer_name']);
|
||||
}
|
||||
|
||||
function getSearchEngineUrl()
|
||||
{
|
||||
if ($this->getReferrerType() == 'search'
|
||||
&& !empty($this->details['referer_name'])
|
||||
) {
|
||||
return \Piwik\Plugins\Referrers\getSearchEngineUrlFromName($this->details['referer_name']);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getSearchEngineIcon()
|
||||
{
|
||||
$searchEngineUrl = $this->getSearchEngineUrl();
|
||||
if (!is_null($searchEngineUrl)) {
|
||||
return \Piwik\Plugins\Referrers\getSearchEngineLogoFromUrl($searchEngineUrl);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getPlugins()
|
||||
{
|
||||
$plugins = array(
|
||||
'config_pdf',
|
||||
'config_flash',
|
||||
'config_java',
|
||||
'config_director',
|
||||
'config_quicktime',
|
||||
'config_realplayer',
|
||||
'config_windowsmedia',
|
||||
'config_gears',
|
||||
'config_silverlight',
|
||||
);
|
||||
$pluginShortNames = array();
|
||||
foreach ($plugins as $plugin) {
|
||||
if ($this->details[$plugin] == 1) {
|
||||
$pluginShortName = substr($plugin, 7);
|
||||
$pluginShortNames[] = $pluginShortName;
|
||||
}
|
||||
}
|
||||
return implode(self::DELIMITER_PLUGIN_NAME, $pluginShortNames);
|
||||
}
|
||||
|
||||
function getPluginIcons()
|
||||
{
|
||||
$pluginNames = $this->getPlugins();
|
||||
if (!empty($pluginNames)) {
|
||||
$pluginNames = explode(self::DELIMITER_PLUGIN_NAME, $pluginNames);
|
||||
$pluginIcons = array();
|
||||
|
||||
foreach ($pluginNames as $plugin) {
|
||||
$pluginIcons[] = array("pluginIcon" => \Piwik\Plugins\UserSettings\getPluginsLogo($plugin), "pluginName" => $plugin);
|
||||
}
|
||||
return $pluginIcons;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getOperatingSystemCode()
|
||||
{
|
||||
return $this->details['config_os'];
|
||||
}
|
||||
|
||||
function getOperatingSystem()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getOSLabel($this->details['config_os']);
|
||||
}
|
||||
|
||||
function getOperatingSystemShortName()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getOSShortLabel($this->details['config_os']);
|
||||
}
|
||||
|
||||
function getOperatingSystemIcon()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getOSLogo($this->details['config_os']);
|
||||
}
|
||||
|
||||
function getBrowserFamilyDescription()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getBrowserTypeLabel($this->getBrowserFamily());
|
||||
}
|
||||
|
||||
function getBrowserFamily()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getBrowserFamily($this->details['config_browser_name']);
|
||||
}
|
||||
|
||||
function getBrowserCode()
|
||||
{
|
||||
return $this->details['config_browser_name'];
|
||||
}
|
||||
|
||||
function getBrowserVersion()
|
||||
{
|
||||
return $this->details['config_browser_version'];
|
||||
}
|
||||
|
||||
function getBrowser()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getBrowserLabel($this->details['config_browser_name'] . ";" . $this->details['config_browser_version']);
|
||||
}
|
||||
|
||||
function getBrowserIcon()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getBrowsersLogo($this->details['config_browser_name'] . ";" . $this->details['config_browser_version']);
|
||||
}
|
||||
|
||||
function getScreenType()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getScreenTypeFromResolution($this->details['config_resolution']);
|
||||
}
|
||||
|
||||
function getDeviceType()
|
||||
{
|
||||
if (\Piwik\Plugin\Manager::getInstance()->isPluginActivated('DevicesDetection')) {
|
||||
return \Piwik\Plugins\DevicesDetection\getDeviceTypeLabel($this->details['config_device_type']);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function getResolution()
|
||||
{
|
||||
return $this->details['config_resolution'];
|
||||
}
|
||||
|
||||
function getScreenTypeIcon()
|
||||
{
|
||||
return \Piwik\Plugins\UserSettings\getScreensLogo($this->getScreenType());
|
||||
}
|
||||
|
||||
function getProvider()
|
||||
{
|
||||
if (isset($this->details['location_provider'])) {
|
||||
return $this->details['location_provider'];
|
||||
} else {
|
||||
return Piwik::translate('General_Unknown');
|
||||
}
|
||||
}
|
||||
|
||||
function getProviderName()
|
||||
{
|
||||
return \Piwik\Plugins\Provider\getPrettyProviderName($this->getProvider());
|
||||
}
|
||||
|
||||
function getProviderUrl()
|
||||
{
|
||||
return \Piwik\Plugins\Provider\getHostnameUrl(@$this->details['location_provider']);
|
||||
}
|
||||
|
||||
function getDateTimeLastAction()
|
||||
{
|
||||
return date('Y-m-d H:i:s', strtotime($this->details['visit_last_action_time']));
|
||||
}
|
||||
|
||||
function getVisitEcommerceStatusIcon()
|
||||
{
|
||||
$status = $this->getVisitEcommerceStatus();
|
||||
|
||||
if (in_array($status, array('ordered', 'orderedThenAbandonedCart'))) {
|
||||
return "plugins/Zeitgeist/images/ecommerceOrder.gif";
|
||||
} elseif ($status == 'abandonedCart') {
|
||||
return "plugins/Zeitgeist/images/ecommerceAbandonedCart.gif";
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getVisitEcommerceStatus()
|
||||
{
|
||||
return APIMetadata::getVisitEcommerceStatusFromId($this->details['visit_goal_buyer']);
|
||||
}
|
||||
|
||||
function getVisitorGoalConvertedIcon()
|
||||
{
|
||||
return $this->isVisitorGoalConverted()
|
||||
? "plugins/Zeitgeist/images/goal.png"
|
||||
: null;
|
||||
}
|
||||
|
||||
function isVisitorGoalConverted()
|
||||
{
|
||||
return $this->details['visit_goal_converted'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes fields that are not meant to be displayed (md5 config hash)
|
||||
* Or that the user should only access if he is Super User or admin (cookie, IP)
|
||||
*
|
||||
* @param array $visitorDetails
|
||||
* @return array
|
||||
*/
|
||||
public static function cleanVisitorDetails($visitorDetails)
|
||||
{
|
||||
$toUnset = array('config_id');
|
||||
if (Piwik::isUserIsAnonymous()) {
|
||||
$toUnset[] = 'idvisitor';
|
||||
$toUnset[] = 'location_ip';
|
||||
}
|
||||
foreach ($toUnset as $keyName) {
|
||||
if (isset($visitorDetails[$keyName])) {
|
||||
unset($visitorDetails[$keyName]);
|
||||
}
|
||||
}
|
||||
|
||||
return $visitorDetails;
|
||||
}
|
||||
|
||||
/**
|
||||
* The &flat=1 feature is used by API.getSuggestedValuesForSegment
|
||||
*
|
||||
* @param $visitorDetailsArray
|
||||
* @return array
|
||||
*/
|
||||
public static function flattenVisitorDetailsArray($visitorDetailsArray)
|
||||
{
|
||||
// NOTE: if you flatten more fields from the "actionDetails" array
|
||||
// ==> also update API/API.php getSuggestedValuesForSegment(), the $segmentsNeedActionsInfo array
|
||||
|
||||
// flatten visit custom variables
|
||||
if (is_array($visitorDetailsArray['customVariables'])) {
|
||||
foreach ($visitorDetailsArray['customVariables'] as $thisCustomVar) {
|
||||
$visitorDetailsArray = array_merge($visitorDetailsArray, $thisCustomVar);
|
||||
}
|
||||
unset($visitorDetailsArray['customVariables']);
|
||||
}
|
||||
|
||||
// flatten page views custom variables
|
||||
$count = 1;
|
||||
foreach ($visitorDetailsArray['actionDetails'] as $action) {
|
||||
if (!empty($action['customVariables'])) {
|
||||
foreach ($action['customVariables'] as $thisCustomVar) {
|
||||
foreach ($thisCustomVar as $cvKey => $cvValue) {
|
||||
$flattenedKeyName = $cvKey . ColumnDelete::APPEND_TO_COLUMN_NAME_TO_KEEP . $count;
|
||||
$visitorDetailsArray[$flattenedKeyName] = $cvValue;
|
||||
$count++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Flatten Goals
|
||||
$count = 1;
|
||||
foreach ($visitorDetailsArray['actionDetails'] as $action) {
|
||||
if (!empty($action['goalId'])) {
|
||||
$flattenedKeyName = 'visitConvertedGoalId' . ColumnDelete::APPEND_TO_COLUMN_NAME_TO_KEEP . $count;
|
||||
$visitorDetailsArray[$flattenedKeyName] = $action['goalId'];
|
||||
$count++;
|
||||
}
|
||||
}
|
||||
|
||||
// Flatten Page Titles/URLs
|
||||
$count = 1;
|
||||
foreach ($visitorDetailsArray['actionDetails'] as $action) {
|
||||
if (!empty($action['url'])) {
|
||||
$flattenedKeyName = 'pageUrl' . ColumnDelete::APPEND_TO_COLUMN_NAME_TO_KEEP . $count;
|
||||
$visitorDetailsArray[$flattenedKeyName] = $action['url'];
|
||||
}
|
||||
|
||||
// API.getSuggestedValuesForSegment
|
||||
$flatten = array( 'pageTitle', 'siteSearchKeyword', 'eventCategory', 'eventAction', 'eventName', 'eventValue');
|
||||
foreach($flatten as $toFlatten) {
|
||||
if (!empty($action[$toFlatten])) {
|
||||
$flattenedKeyName = $toFlatten . ColumnDelete::APPEND_TO_COLUMN_NAME_TO_KEEP . $count;
|
||||
$visitorDetailsArray[$flattenedKeyName] = $action[$toFlatten];
|
||||
}
|
||||
}
|
||||
$count++;
|
||||
}
|
||||
|
||||
// Entry/exit pages
|
||||
$firstAction = $lastAction = false;
|
||||
foreach ($visitorDetailsArray['actionDetails'] as $action) {
|
||||
if ($action['type'] == 'action') {
|
||||
if (empty($firstAction)) {
|
||||
$firstAction = $action;
|
||||
}
|
||||
$lastAction = $action;
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($firstAction['pageTitle'])) {
|
||||
$visitorDetailsArray['entryPageTitle'] = $firstAction['pageTitle'];
|
||||
}
|
||||
if (!empty($firstAction['url'])) {
|
||||
$visitorDetailsArray['entryPageUrl'] = $firstAction['url'];
|
||||
}
|
||||
if (!empty($lastAction['pageTitle'])) {
|
||||
$visitorDetailsArray['exitPageTitle'] = $lastAction['pageTitle'];
|
||||
}
|
||||
if (!empty($lastAction['url'])) {
|
||||
$visitorDetailsArray['exitPageUrl'] = $lastAction['url'];
|
||||
}
|
||||
|
||||
|
||||
return $visitorDetailsArray;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $visitorDetailsArray
|
||||
* @param $actionsLimit
|
||||
* @param $timezone
|
||||
* @return array
|
||||
*/
|
||||
public static function enrichVisitorArrayWithActions($visitorDetailsArray, $actionsLimit, $timezone)
|
||||
{
|
||||
$idVisit = $visitorDetailsArray['idVisit'];
|
||||
|
||||
$maxCustomVariables = CustomVariables::getMaxCustomVariables();
|
||||
|
||||
$sqlCustomVariables = '';
|
||||
for ($i = 1; $i <= $maxCustomVariables; $i++) {
|
||||
$sqlCustomVariables .= ', custom_var_k' . $i . ', custom_var_v' . $i;
|
||||
}
|
||||
// The second join is a LEFT join to allow returning records that don't have a matching page title
|
||||
// eg. Downloads, Outlinks. For these, idaction_name is set to 0
|
||||
$sql = "
|
||||
SELECT
|
||||
COALESCE(log_action_event_category.type, log_action.type, log_action_title.type) AS type,
|
||||
log_action.name AS url,
|
||||
log_action.url_prefix,
|
||||
log_action_title.name AS pageTitle,
|
||||
log_action.idaction AS pageIdAction,
|
||||
log_link_visit_action.server_time as serverTimePretty,
|
||||
log_link_visit_action.time_spent_ref_action as timeSpentRef,
|
||||
log_link_visit_action.idlink_va AS pageId,
|
||||
log_link_visit_action.custom_float
|
||||
". $sqlCustomVariables . ",
|
||||
log_action_event_category.name AS eventCategory,
|
||||
log_action_event_action.name as eventAction
|
||||
FROM " . Common::prefixTable('log_link_visit_action') . " AS log_link_visit_action
|
||||
LEFT JOIN " . Common::prefixTable('log_action') . " AS log_action
|
||||
ON log_link_visit_action.idaction_url = log_action.idaction
|
||||
LEFT JOIN " . Common::prefixTable('log_action') . " AS log_action_title
|
||||
ON log_link_visit_action.idaction_name = log_action_title.idaction
|
||||
LEFT JOIN " . Common::prefixTable('log_action') . " AS log_action_event_category
|
||||
ON log_link_visit_action.idaction_event_category = log_action_event_category.idaction
|
||||
LEFT JOIN " . Common::prefixTable('log_action') . " AS log_action_event_action
|
||||
ON log_link_visit_action.idaction_event_action = log_action_event_action.idaction
|
||||
WHERE log_link_visit_action.idvisit = ?
|
||||
ORDER BY server_time ASC
|
||||
LIMIT 0, $actionsLimit
|
||||
";
|
||||
$actionDetails = Db::fetchAll($sql, array($idVisit));
|
||||
|
||||
foreach ($actionDetails as $actionIdx => &$actionDetail) {
|
||||
$actionDetail =& $actionDetails[$actionIdx];
|
||||
$customVariablesPage = array();
|
||||
|
||||
$maxCustomVariables = CustomVariables::getMaxCustomVariables();
|
||||
|
||||
for ($i = 1; $i <= $maxCustomVariables; $i++) {
|
||||
if (!empty($actionDetail['custom_var_k' . $i])) {
|
||||
$cvarKey = $actionDetail['custom_var_k' . $i];
|
||||
$cvarKey = static::getCustomVariablePrettyKey($cvarKey);
|
||||
$customVariablesPage[$i] = array(
|
||||
'customVariablePageName' . $i => $cvarKey,
|
||||
'customVariablePageValue' . $i => $actionDetail['custom_var_v' . $i],
|
||||
);
|
||||
}
|
||||
unset($actionDetail['custom_var_k' . $i]);
|
||||
unset($actionDetail['custom_var_v' . $i]);
|
||||
}
|
||||
if (!empty($customVariablesPage)) {
|
||||
$actionDetail['customVariables'] = $customVariablesPage;
|
||||
}
|
||||
|
||||
|
||||
if($actionDetail['type'] == Action::TYPE_EVENT_CATEGORY) {
|
||||
// Handle Event
|
||||
if(strlen($actionDetail['pageTitle']) > 0) {
|
||||
$actionDetail['eventName'] = $actionDetail['pageTitle'];
|
||||
}
|
||||
|
||||
unset($actionDetail['pageTitle']);
|
||||
|
||||
} else if ($actionDetail['type'] == Action::TYPE_SITE_SEARCH) {
|
||||
// Handle Site Search
|
||||
$actionDetail['siteSearchKeyword'] = $actionDetail['pageTitle'];
|
||||
unset($actionDetail['pageTitle']);
|
||||
}
|
||||
|
||||
// Event value / Generation time
|
||||
if($actionDetail['type'] == Action::TYPE_EVENT_CATEGORY) {
|
||||
if(strlen($actionDetail['custom_float']) > 0) {
|
||||
$actionDetail['eventValue'] = round($actionDetail['custom_float'], self::EVENT_VALUE_PRECISION);
|
||||
}
|
||||
} elseif ($actionDetail['custom_float'] > 0) {
|
||||
$actionDetail['generationTime'] = \Piwik\MetricsFormatter::getPrettyTimeFromSeconds($actionDetail['custom_float'] / 1000);
|
||||
}
|
||||
unset($actionDetail['custom_float']);
|
||||
|
||||
if($actionDetail['type'] != Action::TYPE_EVENT_CATEGORY) {
|
||||
unset($actionDetail['eventCategory']);
|
||||
unset($actionDetail['eventAction']);
|
||||
}
|
||||
|
||||
// Reconstruct url from prefix
|
||||
$actionDetail['url'] = Tracker\PageUrl::reconstructNormalizedUrl($actionDetail['url'], $actionDetail['url_prefix']);
|
||||
unset($actionDetail['url_prefix']);
|
||||
|
||||
// Set the time spent for this action (which is the timeSpentRef of the next action)
|
||||
if (isset($actionDetails[$actionIdx + 1])) {
|
||||
$actionDetail['timeSpent'] = $actionDetails[$actionIdx + 1]['timeSpentRef'];
|
||||
$actionDetail['timeSpentPretty'] = \Piwik\MetricsFormatter::getPrettyTimeFromSeconds($actionDetail['timeSpent']);
|
||||
}
|
||||
unset($actionDetails[$actionIdx]['timeSpentRef']); // not needed after timeSpent is added
|
||||
|
||||
}
|
||||
|
||||
// If the visitor converted a goal, we shall select all Goals
|
||||
$sql = "
|
||||
SELECT
|
||||
'goal' as type,
|
||||
goal.name as goalName,
|
||||
goal.idgoal as goalId,
|
||||
goal.revenue as revenue,
|
||||
log_conversion.idlink_va as goalPageId,
|
||||
log_conversion.server_time as serverTimePretty,
|
||||
log_conversion.url as url
|
||||
FROM " . Common::prefixTable('log_conversion') . " AS log_conversion
|
||||
LEFT JOIN " . Common::prefixTable('goal') . " AS goal
|
||||
ON (goal.idsite = log_conversion.idsite
|
||||
AND
|
||||
goal.idgoal = log_conversion.idgoal)
|
||||
AND goal.deleted = 0
|
||||
WHERE log_conversion.idvisit = ?
|
||||
AND log_conversion.idgoal > 0
|
||||
ORDER BY server_time ASC
|
||||
LIMIT 0, $actionsLimit
|
||||
";
|
||||
$goalDetails = Db::fetchAll($sql, array($idVisit));
|
||||
|
||||
$sql = "SELECT
|
||||
case idgoal when " . GoalManager::IDGOAL_CART . " then '" . Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART . "' else '" . Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER . "' end as type,
|
||||
idorder as orderId,
|
||||
" . LogAggregator::getSqlRevenue('revenue') . " as revenue,
|
||||
" . LogAggregator::getSqlRevenue('revenue_subtotal') . " as revenueSubTotal,
|
||||
" . LogAggregator::getSqlRevenue('revenue_tax') . " as revenueTax,
|
||||
" . LogAggregator::getSqlRevenue('revenue_shipping') . " as revenueShipping,
|
||||
" . LogAggregator::getSqlRevenue('revenue_discount') . " as revenueDiscount,
|
||||
items as items,
|
||||
|
||||
log_conversion.server_time as serverTimePretty
|
||||
FROM " . Common::prefixTable('log_conversion') . " AS log_conversion
|
||||
WHERE idvisit = ?
|
||||
AND idgoal <= " . GoalManager::IDGOAL_ORDER . "
|
||||
ORDER BY server_time ASC
|
||||
LIMIT 0, $actionsLimit";
|
||||
$ecommerceDetails = Db::fetchAll($sql, array($idVisit));
|
||||
|
||||
foreach ($ecommerceDetails as &$ecommerceDetail) {
|
||||
if ($ecommerceDetail['type'] == Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART) {
|
||||
unset($ecommerceDetail['orderId']);
|
||||
unset($ecommerceDetail['revenueSubTotal']);
|
||||
unset($ecommerceDetail['revenueTax']);
|
||||
unset($ecommerceDetail['revenueShipping']);
|
||||
unset($ecommerceDetail['revenueDiscount']);
|
||||
}
|
||||
|
||||
// 25.00 => 25
|
||||
foreach ($ecommerceDetail as $column => $value) {
|
||||
if (strpos($column, 'revenue') !== false) {
|
||||
if ($value == round($value)) {
|
||||
$ecommerceDetail[$column] = round($value);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Enrich ecommerce carts/orders with the list of products
|
||||
usort($ecommerceDetails, array('static', 'sortByServerTime'));
|
||||
foreach ($ecommerceDetails as $key => &$ecommerceConversion) {
|
||||
$sql = "SELECT
|
||||
log_action_sku.name as itemSKU,
|
||||
log_action_name.name as itemName,
|
||||
log_action_category.name as itemCategory,
|
||||
" . LogAggregator::getSqlRevenue('price') . " as price,
|
||||
quantity as quantity
|
||||
FROM " . Common::prefixTable('log_conversion_item') . "
|
||||
INNER JOIN " . Common::prefixTable('log_action') . " AS log_action_sku
|
||||
ON idaction_sku = log_action_sku.idaction
|
||||
LEFT JOIN " . Common::prefixTable('log_action') . " AS log_action_name
|
||||
ON idaction_name = log_action_name.idaction
|
||||
LEFT JOIN " . Common::prefixTable('log_action') . " AS log_action_category
|
||||
ON idaction_category = log_action_category.idaction
|
||||
WHERE idvisit = ?
|
||||
AND idorder = ?
|
||||
AND deleted = 0
|
||||
LIMIT 0, $actionsLimit
|
||||
";
|
||||
$bind = array($idVisit, isset($ecommerceConversion['orderId'])
|
||||
? $ecommerceConversion['orderId']
|
||||
: GoalManager::ITEM_IDORDER_ABANDONED_CART
|
||||
);
|
||||
|
||||
$itemsDetails = Db::fetchAll($sql, $bind);
|
||||
foreach ($itemsDetails as &$detail) {
|
||||
if ($detail['price'] == round($detail['price'])) {
|
||||
$detail['price'] = round($detail['price']);
|
||||
}
|
||||
}
|
||||
$ecommerceConversion['itemDetails'] = $itemsDetails;
|
||||
}
|
||||
|
||||
$actions = array_merge($actionDetails, $goalDetails, $ecommerceDetails);
|
||||
|
||||
usort($actions, array('static', 'sortByServerTime'));
|
||||
|
||||
$visitorDetailsArray['actionDetails'] = $actions;
|
||||
foreach ($visitorDetailsArray['actionDetails'] as &$details) {
|
||||
switch ($details['type']) {
|
||||
case 'goal':
|
||||
$details['icon'] = 'plugins/Zeitgeist/images/goal.png';
|
||||
break;
|
||||
case Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER:
|
||||
case Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART:
|
||||
$details['icon'] = 'plugins/Zeitgeist/images/' . $details['type'] . '.gif';
|
||||
break;
|
||||
case Action::TYPE_DOWNLOAD:
|
||||
$details['type'] = 'download';
|
||||
$details['icon'] = 'plugins/Zeitgeist/images/download.png';
|
||||
break;
|
||||
case Action::TYPE_OUTLINK:
|
||||
$details['type'] = 'outlink';
|
||||
$details['icon'] = 'plugins/Zeitgeist/images/link.gif';
|
||||
break;
|
||||
case Action::TYPE_SITE_SEARCH:
|
||||
$details['type'] = 'search';
|
||||
$details['icon'] = 'plugins/Zeitgeist/images/search_ico.png';
|
||||
break;
|
||||
case Action::TYPE_EVENT_CATEGORY:
|
||||
$details['type'] = 'event';
|
||||
$details['icon'] = 'plugins/Zeitgeist/images/event.png';
|
||||
break;
|
||||
default:
|
||||
$details['type'] = 'action';
|
||||
$details['icon'] = null;
|
||||
break;
|
||||
}
|
||||
// Convert datetimes to the site timezone
|
||||
$dateTimeVisit = Date::factory($details['serverTimePretty'], $timezone);
|
||||
$details['serverTimePretty'] = $dateTimeVisit->getLocalized(Piwik::translate('CoreHome_ShortDateFormat') . ' %time%');
|
||||
}
|
||||
$visitorDetailsArray['goalConversions'] = count($goalDetails);
|
||||
return $visitorDetailsArray;
|
||||
}
|
||||
|
||||
private static function getCustomVariablePrettyKey($key)
|
||||
{
|
||||
$rename = array(
|
||||
Tracker\ActionSiteSearch::CVAR_KEY_SEARCH_CATEGORY => Piwik::translate('Actions_ColumnSearchCategory'),
|
||||
Tracker\ActionSiteSearch::CVAR_KEY_SEARCH_COUNT => Piwik::translate('Actions_ColumnSearchResultsCount'),
|
||||
);
|
||||
if (isset($rename[$key])) {
|
||||
return $rename[$key];
|
||||
}
|
||||
return $key;
|
||||
}
|
||||
|
||||
private static function sortByServerTime($a, $b)
|
||||
{
|
||||
$ta = strtotime($a['serverTimePretty']);
|
||||
$tb = strtotime($b['serverTimePretty']);
|
||||
return $ta < $tb
|
||||
? -1
|
||||
: ($ta == $tb
|
||||
? 0
|
||||
: 1);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue