506 lines
17 KiB
PHP
506 lines
17 KiB
PHP
<?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\Live;
|
|
|
|
use Exception;
|
|
use Piwik\Common;
|
|
use Piwik\DataAccess\LogAggregator;
|
|
use Piwik\Date;
|
|
use Piwik\Db;
|
|
use Piwik\Period;
|
|
use Piwik\Period\Range;
|
|
use Piwik\Piwik;
|
|
use Piwik\Plugins\CustomVariables\CustomVariables;
|
|
use Piwik\Segment;
|
|
use Piwik\Site;
|
|
use Piwik\Tracker\GoalManager;
|
|
|
|
class Model
|
|
{
|
|
|
|
/**
|
|
* @param $idVisit
|
|
* @param $actionsLimit
|
|
* @return array
|
|
* @throws \Exception
|
|
*/
|
|
public function queryActionsForVisit($idVisit, $actionsLimit)
|
|
{
|
|
$maxCustomVariables = CustomVariables::getNumUsableCustomVariables();
|
|
|
|
$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.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
|
|
" . $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));
|
|
return $actionDetails;
|
|
}
|
|
|
|
/**
|
|
* @param $idVisit
|
|
* @param $limit
|
|
* @return array
|
|
* @throws \Exception
|
|
*/
|
|
public function queryGoalConversionsForVisit($idVisit, $limit)
|
|
{
|
|
$sql = "
|
|
SELECT
|
|
'goal' as type,
|
|
goal.name as goalName,
|
|
goal.idgoal as goalId,
|
|
log_conversion.revenue as revenue,
|
|
log_conversion.idlink_va,
|
|
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, $limit
|
|
";
|
|
$goalDetails = Db::fetchAll($sql, array($idVisit));
|
|
return $goalDetails;
|
|
}
|
|
|
|
/**
|
|
* @param $idVisit
|
|
* @param $limit
|
|
* @return array
|
|
* @throws \Exception
|
|
*/
|
|
public function queryEcommerceConversionsForVisit($idVisit, $limit)
|
|
{
|
|
$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,
|
|
log_conversion.idlink_va
|
|
FROM " . Common::prefixTable('log_conversion') . " AS log_conversion
|
|
WHERE idvisit = ?
|
|
AND idgoal <= " . GoalManager::IDGOAL_ORDER . "
|
|
ORDER BY server_time ASC
|
|
LIMIT 0, $limit";
|
|
$ecommerceDetails = Db::fetchAll($sql, array($idVisit));
|
|
return $ecommerceDetails;
|
|
}
|
|
|
|
|
|
/**
|
|
* @param $idVisit
|
|
* @param $idOrder
|
|
* @param $actionsLimit
|
|
* @return array
|
|
* @throws \Exception
|
|
*/
|
|
public function queryEcommerceItemsForOrder($idVisit, $idOrder, $actionsLimit)
|
|
{
|
|
$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, $idOrder);
|
|
|
|
$itemsDetails = Db::fetchAll($sql, $bind);
|
|
return $itemsDetails;
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param $period
|
|
* @param $date
|
|
* @param $segment
|
|
* @param $limit
|
|
* @param $visitorId
|
|
* @param $minTimestamp
|
|
* @param $filterSortOrder
|
|
* @return array
|
|
* @throws Exception
|
|
*/
|
|
public function queryLogVisits($idSite, $period, $date, $segment, $offset, $limit, $visitorId, $minTimestamp, $filterSortOrder)
|
|
{
|
|
list($sql, $bind) = $this->makeLogVisitsQueryString($idSite, $period, $date, $segment, $offset, $limit, $visitorId, $minTimestamp, $filterSortOrder);
|
|
|
|
return Db::fetchAll($sql, $bind);
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param $lastMinutes
|
|
* @param $segment
|
|
* @return int
|
|
* @throws Exception
|
|
*/
|
|
public function getNumActions($idSite, $lastMinutes, $segment)
|
|
{
|
|
return $this->getLastMinutesCounterForQuery(
|
|
$idSite,
|
|
$lastMinutes,
|
|
$segment,
|
|
'COUNT(*)',
|
|
'log_link_visit_action',
|
|
'log_link_visit_action.server_time >= ?'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param $lastMinutes
|
|
* @param $segment
|
|
* @return int
|
|
* @throws Exception
|
|
*/
|
|
public function getNumVisitsConverted($idSite, $lastMinutes, $segment)
|
|
{
|
|
return $this->getLastMinutesCounterForQuery(
|
|
$idSite,
|
|
$lastMinutes,
|
|
$segment,
|
|
'COUNT(*)',
|
|
'log_conversion',
|
|
'log_conversion.server_time >= ?'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param $lastMinutes
|
|
* @param $segment
|
|
* @return int
|
|
* @throws Exception
|
|
*/
|
|
public function getNumVisits($idSite, $lastMinutes, $segment)
|
|
{
|
|
return $this->getLastMinutesCounterForQuery(
|
|
$idSite,
|
|
$lastMinutes,
|
|
$segment,
|
|
'COUNT(log_visit.visit_last_action_time)',
|
|
'log_visit',
|
|
'log_visit.visit_last_action_time >= ?'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param $lastMinutes
|
|
* @param $segment
|
|
* @return int
|
|
* @throws Exception
|
|
*/
|
|
public function getNumVisitors($idSite, $lastMinutes, $segment)
|
|
{
|
|
return $this->getLastMinutesCounterForQuery(
|
|
$idSite,
|
|
$lastMinutes,
|
|
$segment,
|
|
'COUNT(DISTINCT log_visit.idvisitor)',
|
|
'log_visit',
|
|
'log_visit.visit_last_action_time >= ?'
|
|
);
|
|
}
|
|
|
|
private function getLastMinutesCounterForQuery($idSite, $lastMinutes, $segment, $select, $from, $where)
|
|
{
|
|
$lastMinutes = (int)$lastMinutes;
|
|
|
|
if (empty($lastMinutes)) {
|
|
return 0;
|
|
}
|
|
|
|
list($whereIdSites, $idSites) = $this->getIdSitesWhereClause($idSite, $from);
|
|
|
|
$bind = $idSites;
|
|
$bind[] = Date::factory(time() - $lastMinutes * 60)->toString('Y-m-d H:i:s');
|
|
|
|
$where = $whereIdSites . "AND " . $where;
|
|
|
|
$segment = new Segment($segment, $idSite);
|
|
$query = $segment->getSelectQuery($select, $from, $where, $bind);
|
|
|
|
$numVisitors = Db::fetchOne($query['sql'], $query['bind']);
|
|
|
|
return $numVisitors;
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param string $table
|
|
* @return array
|
|
*/
|
|
private function getIdSitesWhereClause($idSite, $table = 'log_visit')
|
|
{
|
|
$idSites = array($idSite);
|
|
Piwik::postEvent('Live.API.getIdSitesString', array(&$idSites));
|
|
|
|
$idSitesBind = Common::getSqlStringFieldsArray($idSites);
|
|
$whereClause = $table . ".idsite in ($idSitesBind) ";
|
|
return array($whereClause, $idSites);
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns the ID of a visitor that is adjacent to another visitor (by time of last action)
|
|
* in the log_visit table.
|
|
*
|
|
* @param int $idSite The ID of the site whose visits should be looked at.
|
|
* @param string $visitorId The ID of the visitor to get an adjacent visitor for.
|
|
* @param string $visitLastActionTime The last action time of the latest visit for $visitorId.
|
|
* @param string $segment
|
|
* @param bool $getNext Whether to retrieve the next visitor or the previous visitor. The next
|
|
* visitor will be the visitor that appears chronologically later in the
|
|
* log_visit table. The previous visitor will be the visitor that appears
|
|
* earlier.
|
|
* @return string The hex visitor ID.
|
|
* @throws Exception
|
|
*/
|
|
public function queryAdjacentVisitorId($idSite, $visitorId, $visitLastActionTime, $segment, $getNext)
|
|
{
|
|
if ($getNext) {
|
|
$visitLastActionTimeCondition = "sub.visit_last_action_time <= ?";
|
|
$orderByDir = "DESC";
|
|
} else {
|
|
$visitLastActionTimeCondition = "sub.visit_last_action_time >= ?";
|
|
$orderByDir = "ASC";
|
|
}
|
|
|
|
$visitLastActionDate = Date::factory($visitLastActionTime);
|
|
$dateOneDayAgo = $visitLastActionDate->subDay(1);
|
|
$dateOneDayInFuture = $visitLastActionDate->addDay(1);
|
|
|
|
$select = "log_visit.idvisitor, MAX(log_visit.visit_last_action_time) as visit_last_action_time";
|
|
$from = "log_visit";
|
|
$where = "log_visit.idsite = ? AND log_visit.idvisitor <> ? AND visit_last_action_time >= ? and visit_last_action_time <= ?";
|
|
$whereBind = array($idSite, @Common::hex2bin($visitorId), $dateOneDayAgo->toString('Y-m-d H:i:s'), $dateOneDayInFuture->toString('Y-m-d H:i:s'));
|
|
$orderBy = "MAX(log_visit.visit_last_action_time) $orderByDir";
|
|
$groupBy = "log_visit.idvisitor";
|
|
|
|
$segment = new Segment($segment, $idSite);
|
|
$queryInfo = $segment->getSelectQuery($select, $from, $where, $whereBind, $orderBy, $groupBy);
|
|
|
|
$sql = "SELECT sub.idvisitor, sub.visit_last_action_time FROM ({$queryInfo['sql']}) as sub
|
|
WHERE $visitLastActionTimeCondition
|
|
LIMIT 1";
|
|
$bind = array_merge($queryInfo['bind'], array($visitLastActionTime));
|
|
|
|
$visitorId = Db::fetchOne($sql, $bind);
|
|
if (!empty($visitorId)) {
|
|
$visitorId = bin2hex($visitorId);
|
|
}
|
|
return $visitorId;
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @param $period
|
|
* @param $date
|
|
* @param $segment
|
|
* @param int $offset
|
|
* @param int $limit
|
|
* @param $visitorId
|
|
* @param $minTimestamp
|
|
* @param $filterSortOrder
|
|
* @return array
|
|
* @throws Exception
|
|
*/
|
|
public function makeLogVisitsQueryString($idSite, $period, $date, $segment, $offset, $limit, $visitorId, $minTimestamp, $filterSortOrder)
|
|
{
|
|
// If no other filter, only look at the last 24 hours of stats
|
|
if (empty($visitorId)
|
|
&& empty($limit)
|
|
&& empty($offset)
|
|
&& empty($period)
|
|
&& empty($date)
|
|
) {
|
|
$period = 'day';
|
|
$date = 'yesterdaySameTime';
|
|
}
|
|
|
|
|
|
list($whereClause, $bindIdSites) = $this->getIdSitesWhereClause($idSite);
|
|
|
|
list($whereBind, $where) = $this->getWhereClauseAndBind($whereClause, $bindIdSites, $idSite, $period, $date, $visitorId, $minTimestamp);
|
|
|
|
if (strtolower($filterSortOrder) !== 'asc') {
|
|
$filterSortOrder = 'DESC';
|
|
}
|
|
|
|
$segment = new Segment($segment, $idSite);
|
|
|
|
// Subquery to use the indexes for ORDER BY
|
|
$select = "log_visit.*";
|
|
$from = "log_visit";
|
|
$groupBy = false;
|
|
$limit = $limit >= 1 ? (int)$limit : 0;
|
|
$offset = $offset >= 1 ? (int)$offset : 0;
|
|
|
|
$orderBy = '';
|
|
if (count($bindIdSites) <= 1) {
|
|
$orderBy = 'idsite, ';
|
|
}
|
|
|
|
$orderBy .= "visit_last_action_time " . $filterSortOrder;
|
|
$orderByParent = "sub.visit_last_action_time " . $filterSortOrder;
|
|
|
|
$subQuery = $segment->getSelectQuery($select, $from, $where, $whereBind, $orderBy, $groupBy, $limit, $offset);
|
|
|
|
$bind = $subQuery['bind'];
|
|
// Group by idvisit so that a visitor converting 2 goals only appears once
|
|
$sql = "
|
|
SELECT sub.* FROM (
|
|
" . $subQuery['sql'] . "
|
|
) AS sub
|
|
GROUP BY sub.idvisit
|
|
ORDER BY $orderByParent
|
|
";
|
|
return array($sql, $bind);
|
|
}
|
|
|
|
/**
|
|
* @param $idSite
|
|
* @return Site
|
|
*/
|
|
protected function makeSite($idSite)
|
|
{
|
|
return new Site($idSite);
|
|
}
|
|
|
|
/**
|
|
* @param string $whereClause
|
|
* @param array $bindIdSites
|
|
* @param $idSite
|
|
* @param $period
|
|
* @param $date
|
|
* @param $visitorId
|
|
* @param $minTimestamp
|
|
* @return array
|
|
* @throws Exception
|
|
*/
|
|
private function getWhereClauseAndBind($whereClause, $bindIdSites, $idSite, $period, $date, $visitorId, $minTimestamp)
|
|
{
|
|
$where = array();
|
|
$where[] = $whereClause;
|
|
$whereBind = $bindIdSites;
|
|
|
|
if (!empty($visitorId)) {
|
|
$where[] = "log_visit.idvisitor = ? ";
|
|
$whereBind[] = @Common::hex2bin($visitorId);
|
|
}
|
|
|
|
if (!empty($minTimestamp)) {
|
|
$where[] = "log_visit.visit_last_action_time > ? ";
|
|
$whereBind[] = date("Y-m-d H:i:s", $minTimestamp);
|
|
}
|
|
|
|
// SQL Filter with provided period
|
|
if (!empty($period) && !empty($date)) {
|
|
$currentSite = $this->makeSite($idSite);
|
|
$currentTimezone = $currentSite->getTimezone();
|
|
|
|
$dateString = $date;
|
|
if ($period == 'range') {
|
|
$processedPeriod = new Range('range', $date);
|
|
if ($parsedDate = Range::parseDateRange($date)) {
|
|
$dateString = $parsedDate[2];
|
|
}
|
|
} else {
|
|
$processedDate = Date::factory($date);
|
|
if ($date == 'today'
|
|
|| $date == 'now'
|
|
|| $processedDate->toString() == Date::factory('now', $currentTimezone)->toString()
|
|
) {
|
|
$processedDate = $processedDate->subDay(1);
|
|
}
|
|
$processedPeriod = Period\Factory::build($period, $processedDate);
|
|
}
|
|
$dateStart = $processedPeriod->getDateStart()->setTimezone($currentTimezone);
|
|
$where[] = "log_visit.visit_last_action_time >= ?";
|
|
$whereBind[] = $dateStart->toString('Y-m-d H:i:s');
|
|
|
|
if (!in_array($date, array('now', 'today', 'yesterdaySameTime'))
|
|
&& strpos($date, 'last') === false
|
|
&& strpos($date, 'previous') === false
|
|
&& Date::factory($dateString)->toString('Y-m-d') != Date::factory('now', $currentTimezone)->toString()
|
|
) {
|
|
$dateEnd = $processedPeriod->getDateEnd()->setTimezone($currentTimezone);
|
|
$where[] = " log_visit.visit_last_action_time <= ?";
|
|
$dateEndString = $dateEnd->addDay(1)->toString('Y-m-d H:i:s');
|
|
$whereBind[] = $dateEndString;
|
|
}
|
|
}
|
|
|
|
if (count($where) > 0) {
|
|
$where = join("
|
|
AND ", $where);
|
|
} else {
|
|
$where = false;
|
|
}
|
|
return array($whereBind, $where);
|
|
}
|
|
}
|