diff options
Diffstat (limited to 'plugins/Actions/VisitorDetails.php')
| -rw-r--r-- | plugins/Actions/VisitorDetails.php | 360 |
1 files changed, 360 insertions, 0 deletions
diff --git a/plugins/Actions/VisitorDetails.php b/plugins/Actions/VisitorDetails.php new file mode 100644 index 0000000000..becb6cdaf7 --- /dev/null +++ b/plugins/Actions/VisitorDetails.php @@ -0,0 +1,360 @@ +<?php +/** + * Piwik - free/libre analytics platform + * + * @link http://piwik.org + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later + * + */ +namespace Piwik\Plugins\Actions; + +use Piwik\Common; +use Piwik\Config; +use Piwik\Date; +use Piwik\Db; +use Piwik\Metrics\Formatter; +use Piwik\Piwik; +use Piwik\Plugins\Live\VisitorDetailsAbstract; +use Piwik\Site; +use Piwik\Tracker\Action; +use Piwik\Tracker\PageUrl; +use Piwik\View; + +class VisitorDetails extends VisitorDetailsAbstract +{ + public function extendVisitorDetails(&$visitor) + { + $visitor['searches'] = $this->details['visit_total_searches']; + $visitor['actions'] = $this->details['visit_total_actions']; + $visitor['interactions'] = $this->details['visit_total_interactions']; + } + + public function provideActionsForVisitIds(&$actions, $visitIds) + { + $actionDetails = $this->queryActionsForVisits($visitIds); + // use while / array_shift combination instead of foreach to save memory + while (is_array($actionDetails) && count($actionDetails)) { + $action = array_shift($actionDetails); + $idVisit = $action['idvisit']; + unset($action['idvisit']); + $actions[$idVisit][] = $action; + } + } + + + public function provideActionsForVisit(&$actions, $visitorDetails) + { + $actionDetails = $actions; + + $formatter = new Formatter(); + + // Enrich with time spent per action + $nextActionId = 0; + foreach ($actionDetails as $idx => &$action) { + + if ($idx < $nextActionId || !$this->shouldHandleAction($action)) { + continue; // skip to next action having timeSpentRef + } + + // search for next action with timeSpentRef + $nextActionId = $idx + 1; + $nextAction = null; + + while (isset($actionDetails[$nextActionId]) && + (!$this->shouldHandleAction($actionDetails[$nextActionId]) || + !array_key_exists('timeSpentRef', $actionDetails[$nextActionId]))) { + $nextActionId++; + } + $nextAction = isset($actionDetails[$nextActionId]) ? $actionDetails[$nextActionId] : null; + + // Set the time spent for this action (which is the timeSpentRef of the next action) + if ($nextAction) { + $action['timeSpent'] = $nextAction['timeSpentRef']; + } else { + + // Last action of a visit. + // By default, Piwik does not know how long the user stayed on the page + // If enableHeartBeatTimer() is used in piwik.js then we can find the accurate time on page for the last pageview + $visitTotalTime = $visitorDetails['visitDuration']; + $timeOfLastAction = Date::factory($action['serverTimePretty'])->getTimestamp(); + + $timeSpentOnAllActionsApartFromLastOne = ($timeOfLastAction - $visitorDetails['firstActionTimestamp']); + $timeSpentOnPage = $visitTotalTime - $timeSpentOnAllActionsApartFromLastOne; + + // Safe net, we assume the time is correct when it's more than 10 seconds + if ($timeSpentOnPage > 10) { + $action['timeSpent'] = $timeSpentOnPage; + } + } + + if (isset($action['timeSpent'])) { + $action['timeSpentPretty'] = $formatter->getPrettyTimeFromSeconds($action['timeSpent'], true); + } + + unset($action['timeSpentRef']); // not needed after timeSpent is added + } + + $actions = $actionDetails; + } + + private function shouldHandleAction($action) { + $actionTypesToHandle = array( + Action::TYPE_PAGE_URL, + Action::TYPE_SITE_SEARCH, + Action::TYPE_EVENT, + Action::TYPE_OUTLINK, + Action::TYPE_DOWNLOAD + ); + + return in_array($action['type'], $actionTypesToHandle) || !empty($action['eventType']); + } + + public function extendActionDetails(&$action, $nextAction, $visitorDetails) + { + $formatter = new Formatter(); + + if ($action['type'] == Action::TYPE_SITE_SEARCH) { + // Handle Site Search + $action['siteSearchKeyword'] = $action['pageTitle']; + unset($action['pageTitle']); + } + + // Generation time + if ($this->shouldHandleAction($action) && empty($action['eventType']) && isset($action['custom_float']) && $action['custom_float'] > 0) { + $action['generationTimeMilliseconds'] = $action['custom_float']; + $action['generationTime'] = $formatter->getPrettyTimeFromSeconds($action['custom_float'] / 1000, true); + unset($action['custom_float']); + } + + if (array_key_exists('custom_float', $action) && is_null($action['custom_float'])) { + unset($action['custom_float']); + } + + if (array_key_exists('interaction_position', $action)) { + $action['interactionPosition'] = $action['interaction_position']; + unset($action['interaction_position']); + } + + // Reconstruct url from prefix + if (array_key_exists('url', $action) && array_key_exists('url_prefix', $action)) { + $url = PageUrl::reconstructNormalizedUrl($action['url'], $action['url_prefix']); + $url = Common::unsanitizeInputValue($url); + + $action['url'] = $url; + unset($action['url_prefix']); + } + + switch ($action['type']) { + case 'goal': + $action['icon'] = 'plugins/Morpheus/images/goal.png'; + break; + case Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_ORDER: + case Piwik::LABEL_ID_GOAL_IS_ECOMMERCE_CART: + $action['icon'] = 'plugins/Morpheus/images/' . $action['type'] . '.png'; + break; + case Action::TYPE_DOWNLOAD: + $action['type'] = 'download'; + $action['icon'] = 'plugins/Morpheus/images/download.png'; + break; + case Action::TYPE_OUTLINK: + $action['type'] = 'outlink'; + $action['icon'] = 'plugins/Morpheus/images/link.png'; + break; + case Action::TYPE_SITE_SEARCH: + $action['type'] = 'search'; + $action['icon'] = 'plugins/Morpheus/images/search_ico.png'; + break; + case Action::TYPE_PAGE_URL: + case '': + $action['type'] = 'action'; + $action['icon'] = null; + break; + } + + // Convert datetimes to the site timezone + $dateTimeVisit = Date::factory($action['serverTimePretty'], + Site::getTimezoneFor($visitorDetails['idSite'])); + $action['serverTimePretty'] = $dateTimeVisit->getLocalized(Date::DATETIME_FORMAT_SHORT); + $action['timestamp'] = $dateTimeVisit->getTimestamp(); + + unset($action['idlink_va']); + } + + /** + * @param $idVisit + * @return array + * @throws \Exception + */ + protected function queryActionsForVisits($idVisits) + { + $customFields = array(); + $customJoins = array(); + + Piwik::postEvent('Actions.getCustomActionDimensionFieldsAndJoins', array(&$customFields, &$customJoins)); + + $customFields = array_filter($customFields); + array_unshift($customFields, ''); // add empty element at first + $customActionDimensionFields = implode(', ', $customFields); + + // 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 + log_link_visit_action.idvisit, + COALESCE(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.idpageview, + log_link_visit_action.idlink_va, + 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, + log_link_visit_action.interaction_position + " . $customActionDimensionFields . " + 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 + " . implode(" ", $customJoins) . " + WHERE log_link_visit_action.idvisit IN ('" . implode("','", $idVisits) . "') + ORDER BY log_link_visit_action.idvisit, server_time ASC + "; + $actionDetails = Db::fetchAll($sql); + return $actionDetails; + } + + + private $visitedPageUrls = array(); + private $siteSearchKeywords = array(); + private $pageGenerationTimeTotal = 0; + + public function initProfile($visits, &$profile) + { + $this->visitedPageUrls = array(); + $this->siteSearchKeywords = array(); + $this->pageGenerationTimeTotal = 0; + $profile['totalActions'] = 0; + $profile['totalOutlinks'] = 0; + $profile['totalDownloads'] = 0; + $profile['totalSearches'] = 0; + $profile['totalPageViews'] = 0; + $profile['totalUniquePageViews'] = 0; + $profile['totalRevisitedPages'] = 0; + $profile['totalPageViewsWithTiming'] = 0; + $profile['searches'] = array(); + } + + public function handleProfileVisit($visit, &$profile) + { + $profile['totalActions'] += $visit->getColumn('actions'); + } + + public function handleProfileAction($action, &$profile) + { + $this->handleIfDownloadAction($action, $profile); + $this->handleIfOutlinkAction($action, $profile); + $this->handleIfSiteSearchAction($action, $profile); + $this->handleIfPageViewAction($action, $profile); + $this->handleIfPageGenerationTime($action, $profile); + } + + public function finalizeProfile($visits, &$profile) + { + arsort($this->visitedPageUrls); + $profile['visitedPages'] = $this->visitedPageUrls; + + $this->handleSiteSearches($profile); + $this->handleAveragePageGenerationTime($profile); + } + + /** + * @param $action + */ + private function handleIfDownloadAction($action, &$profile) + { + if ($action['type'] != 'download') { + return; + } + $profile['totalDownloads']++; + } + + /** + * @param $action + */ + private function handleIfOutlinkAction($action, &$profile) + { + if ($action['type'] != 'outlink') { + return; + } + $profile['totalOutlinks']++; + } + + /** + * @param $action + */ + private function handleIfPageViewAction($action, &$profile) + { + if ($action['type'] != 'action') { + return; + } + $profile['totalPageViews']++; + $pageUrl = $action['url']; + if (!empty($pageUrl)) { + if (!array_key_exists($pageUrl, $this->visitedPageUrls)) { + $this->visitedPageUrls[$pageUrl] = 0; + $profile['totalUniquePageViews']++; + } + $this->visitedPageUrls[$pageUrl]++; + if ($this->visitedPageUrls[$pageUrl] == 2) { + $profile['totalRevisitedPages']++; + } + } + } + + private function handleIfSiteSearchAction($action, &$profile) + { + if (!isset($action['siteSearchKeyword'])) { + return; + } + $keyword = $action['siteSearchKeyword']; + + if (!isset($this->siteSearchKeywords[$keyword])) { + $this->siteSearchKeywords[$keyword] = 0; + ++$profile['totalSearches']; + } + ++$this->siteSearchKeywords[$keyword]; + } + + private function handleSiteSearches(&$profile) + { + // sort by visit/action + arsort($this->siteSearchKeywords); + + foreach ($this->siteSearchKeywords as $keyword => $searchCount) { + $profile['searches'][] = array( + 'keyword' => $keyword, + 'searches' => $searchCount + ); + } + } + + private function handleIfPageGenerationTime($action, &$profile) + { + if (isset($action['generationTimeMilliseconds'])) { + $this->pageGenerationTimeTotal += $action['generationTimeMilliseconds']; + ++$profile['totalPageViewsWithTiming']; + } + } + + private function handleAveragePageGenerationTime(&$profile) + { + if ($profile['totalPageViewsWithTiming']) { + $profile['averagePageGenerationTime'] = + round($this->pageGenerationTimeTotal / (1000 * $profile['totalPageViewsWithTiming']), $precision = 3); + } + } +}
\ No newline at end of file |