update Piwik to version 2.16 (fixes #91)

www/analytics/plugins/CoreHome/Columns/IdSite.php

@@ -0,0 +1,47 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker;
+use Piwik\Tracker\Visitor;
+
+class IdSite extends VisitDimension
+{
+    protected $columnName = 'idsite';
+    // we do not install or define column definition here as we need to create this column when installing as there is
+    // an index on it. Currently we do not define the index here... although we could overwrite the install() method
+    // and add column 'idsite' and add index. Problem is there is also an index
+    // INDEX(idsite, config_id, visit_last_action_time) and we maybe not be sure whether config_id already exists at
+    // installing point (we do not know whether visit_last_action_time or idsite column would be added first).
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getIdSite();
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getIdSite();
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/ActionsPerVisit.php

@@ -0,0 +1,45 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable\Row;
+use Piwik\Piwik;
+use Piwik\Plugin\ProcessedMetric;
+
+/**
+ * The average number of actions per visit. Calculated as:
+ *
+ *     nb_actions / nb_visits
+ *
+ * nb_actions & nb_visits are calculated during archiving.
+ */
+class ActionsPerVisit extends ProcessedMetric
+{
+    public function getName()
+    {
+        return 'nb_actions_per_visit';
+    }
+
+    public function compute(Row $row)
+    {
+        $actions = $this->getMetric($row, 'nb_actions');
+        $visits = $this->getMetric($row, 'nb_visits');
+
+        return Piwik::getQuotientSafe($actions, $visits, $precision = 1);
+    }
+
+    public function getTranslatedName()
+    {
+        return Piwik::translate('General_ColumnActionsPerVisit');
+    }
+
+    public function getDependentMetrics()
+    {
+        return array('nb_actions', 'nb_visits');
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/AverageTimeOnSite.php

@@ -0,0 +1,53 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable\Row;
+use Piwik\Metrics\Formatter;
+use Piwik\Piwik;
+use Piwik\Plugin\ProcessedMetric;
+
+/**
+ * The average number of seconds spent on the site per visit. Calculated as:
+ *
+ *     sum_visit_length / nb_visits
+ *
+ * sum_visit_length & nb_visits are calculated during archiving.
+ *
+ * @api
+ */
+class AverageTimeOnSite extends ProcessedMetric
+{
+    public function getName()
+    {
+        return 'avg_time_on_site';
+    }
+
+    public function compute(Row $row)
+    {
+        $sumVisitLength = $this->getMetric($row, 'sum_visit_length');
+        $nbVisits = $this->getMetric($row, 'nb_visits');
+
+        return Piwik::getQuotientSafe($sumVisitLength, $nbVisits, $precision = 0);
+    }
+
+    public function format($value, Formatter $formatter)
+    {
+        return $formatter->getPrettyTimeFromSeconds($value);
+    }
+
+    public function getTranslatedName()
+    {
+        return Piwik::translate('General_ColumnAvgTimeOnSite');
+    }
+
+    public function getDependentMetrics()
+    {
+        return array('sum_visit_length', 'nb_visits');
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/BounceRate.php

@@ -0,0 +1,52 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable\Row;
+use Piwik\Metrics\Formatter;
+use Piwik\Piwik;
+use Piwik\Plugin\ProcessedMetric;
+
+/**
+ * The percentage of visits that leave the site without visiting another page. Calculated
+ * as:
+ *
+ *     bounce_count / nb_visits
+ *
+ * bounce_count & nb_visits are calculated by an Archiver.
+ */
+class BounceRate extends ProcessedMetric
+{
+    public function getName()
+    {
+        return 'bounce_rate';
+    }
+
+    public function getTranslatedName()
+    {
+        return Piwik::translate('General_ColumnBounceRate');
+    }
+
+    public function getDependentMetrics()
+    {
+        return array('bounce_count', 'nb_visits');
+    }
+
+    public function format($value, Formatter $formatter)
+    {
+        return $formatter->getPrettyPercentFromQuotient($value);
+    }
+
+    public function compute(Row $row)
+    {
+        $bounceCount = $this->getMetric($row, 'bounce_count');
+        $visits = $this->getMetric($row, 'nb_visits');
+
+        return Piwik::getQuotientSafe($bounceCount, $visits, $precision = 2);
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/CallableProcessedMetric.php

@@ -0,0 +1,47 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable\Row;
+use Piwik\Plugin\ProcessedMetric;
+
+class CallableProcessedMetric extends ProcessedMetric
+{
+    private $name;
+    private $callback;
+    private $dependentMetrics;
+
+    public function __construct($name, $callback, $dependentMetrics = array())
+    {
+        $this->name = $name;
+        $this->callback = $callback;
+        $this->dependentMetrics = $dependentMetrics;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    public function compute(Row $row)
+    {
+        if ($this->callback) {
+            return call_user_func($this->callback, $row);
+        }
+    }
+
+    public function getTranslatedName()
+    {
+        return '';
+    }
+
+    public function getDependentMetrics()
+    {
+        return $this->dependentMetrics;
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/ConversionRate.php

@@ -0,0 +1,51 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable\Row;
+use Piwik\Metrics\Formatter;
+use Piwik\Piwik;
+use Piwik\Plugin\ProcessedMetric;
+
+/**
+ * The percent of visits that result in a conversion. Calculated as:
+ *
+ *     nb_visits_converted / nb_visits
+ *
+ * nb_visits_converted & nb_visits are calculated by the archiving process.
+ */
+class ConversionRate extends ProcessedMetric
+{
+    public function getName()
+    {
+        return 'conversion_rate';
+    }
+
+    public function getTranslatedName()
+    {
+        return Piwik::translate('General_ColumnConversionRate');
+    }
+
+    public function getDependentMetrics()
+    {
+        return array('nb_visits_converted', 'nb_visits');
+    }
+
+    public function format($value, Formatter $formatter)
+    {
+        return $formatter->getPrettyPercentFromQuotient($value);
+    }
+
+    public function compute(Row $row)
+    {
+        $nbVisitsConverted = $this->getMetric($row, 'nb_visits_converted');
+        $nbVisits = $this->getMetric($row, 'nb_visits');
+
+        return Piwik::getQuotientSafe($nbVisitsConverted, $nbVisits, $precision = 4);
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/EvolutionMetric.php

@@ -0,0 +1,123 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable;
+use Piwik\DataTable\Row;
+use Piwik\Metrics\Formatter;
+use Piwik\Piwik;
+use Piwik\Plugin\Metric;
+use Piwik\Plugin\ProcessedMetric;
+
+/**
+ * Calculates evolution values for any other metric. An evolution is the percent change from a
+ * point in the past to the present. They are computed as:
+ *
+ *     (current value - value in past) / value in past
+ *
+ * @api
+ */
+class EvolutionMetric extends ProcessedMetric
+{
+    /**
+     * @var Metric|string
+     */
+    private $wrapped;
+
+    /**
+     * @var string
+     */
+    private $evolutionMetricName;
+
+    /**
+     * @var int
+     */
+    private $quotientPrecision;
+
+    /**
+     * @var DataTable
+     */
+    private $pastData;
+
+    /**
+     * Constructor.
+     *
+     * @param string|Metric $wrapped The metric used to calculate the evolution.
+     * @param DataTable $pastData The data in the past to use when calculating evolutions.
+     * @param string|false $evolutionMetricName The name of the evolution processed metric. Defaults to
+     *                                          $wrapped's name with `'_evolution'` appended.
+     * @param int $quotientPrecision The percent's quotient precision.
+     */
+    public function __construct($wrapped, DataTable $pastData, $evolutionMetricName = false, $quotientPrecision = 0)
+    {
+        $this->wrapped = $wrapped;
+        $this->pastData = $pastData;
+
+        if (empty($evolutionMetricName)) {
+            $wrappedName = $this->getWrappedName();
+            $evolutionMetricName = $wrappedName . '_evolution';
+        }
+
+        $this->evolutionMetricName = $evolutionMetricName;
+        $this->quotientPrecision = $quotientPrecision;
+    }
+
+    public function getName()
+    {
+        return $this->evolutionMetricName;
+    }
+
+    public function getTranslatedName()
+    {
+        return $this->wrapped instanceof Metric ? $this->wrapped->getTranslatedName() : $this->getName();
+    }
+
+    public function compute(Row $row)
+    {
+        $columnName = $this->getWrappedName();
+        $pastRow = $this->getPastRowFromCurrent($row);
+
+        $currentValue = $this->getMetric($row, $columnName);
+        $pastValue = $pastRow ? $this->getMetric($pastRow, $columnName) : 0;
+
+        $dividend = $currentValue - $pastValue;
+        $divisor = $pastValue;
+
+        if ($dividend == 0) {
+            return 0;
+        } else if ($divisor == 0) {
+            return 1;
+        } else {
+            return Piwik::getQuotientSafe($dividend, $divisor, $this->quotientPrecision + 2);
+        }
+    }
+
+    public function format($value, Formatter $formatter)
+    {
+        return $formatter->getPrettyPercentFromQuotient($value);
+    }
+
+    public function getDependentMetrics()
+    {
+        return array($this->getWrappedName());
+    }
+
+    protected function getWrappedName()
+    {
+        return $this->wrapped instanceof Metric ? $this->wrapped->getName() : $this->wrapped;
+    }
+
+    /**
+     * public for Insights use.
+     */
+    public function getPastRowFromCurrent(Row $row)
+    {
+        return $this->pastData->getRowFromLabel($row->getColumn('label'));
+    }
+}

www/analytics/plugins/CoreHome/Columns/Metrics/VisitsPercent.php

@@ -0,0 +1,77 @@
+<?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\CoreHome\Columns\Metrics;
+
+use Piwik\DataTable;
+use Piwik\DataTable\Row;
+use Piwik\Metrics\Formatter;
+use Piwik\Piwik;
+use Piwik\Plugin\ProcessedMetric;
+use Piwik\Plugin\Report;
+
+/**
+ * Percent of visits in the whole table. Calculated as:
+ *
+ *     nb_visits / sum(all nb_visits in table)
+ *
+ * nb_visits is calculated by core archiving process.
+ */
+class VisitsPercent extends ProcessedMetric
+{
+    private $cachedTotalVisits = null;
+    private $forceTotalVisits = null;
+
+    /**
+     * Constructor.
+     *
+     * @param int|null $totalVisits The forced value of total visits to use.
+     */
+    public function __construct($totalVisits = null)
+    {
+        $this->forceTotalVisits = $totalVisits;
+    }
+
+    public function getName()
+    {
+        return 'nb_visits_percentage';
+    }
+
+    public function getTranslatedName()
+    {
+        return Piwik::translate('General_ColumnPercentageVisits');
+    }
+
+    public function compute(Row $row)
+    {
+        $visits = $this->getMetric($row, 'nb_visits');
+
+        return Piwik::getQuotientSafe($visits, $this->cachedTotalVisits, $precision = 2);
+    }
+
+    public function format($value, Formatter $formatter)
+    {
+        return $formatter->getPrettyPercentFromQuotient($value);
+    }
+
+    public function getDependentMetrics()
+    {
+        return array('nb_visits');
+    }
+
+    public function beforeCompute($report, DataTable $table)
+    {
+        if ($this->forceTotalVisits === null) {
+            $this->cachedTotalVisits = array_sum($this->getMetricValues($table, 'nb_visits'));
+        } else {
+            $this->cachedTotalVisits = $this->forceTotalVisits;
+        }
+
+        return true; // always compute
+    }
+}

www/analytics/plugins/CoreHome/Columns/ServerTime.php

@@ -0,0 +1,38 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Date;
+use Piwik\Db;
+use Piwik\Plugin\Dimension\ActionDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker;
+
+class ServerTime extends ActionDimension
+{
+    protected $columnName = 'server_time';
+    protected $columnType = 'DATETIME NOT NULL';
+
+    public function install()
+    {
+        $changes = parent::install();
+        $changes['log_link_visit_action'][] = "ADD INDEX index_idsite_servertime ( idsite, server_time )";
+
+        return $changes;
+    }
+
+    public function onNewAction(Request $request, Visitor $visitor, Action $action)
+    {
+        $timestamp = $request->getCurrentTimestamp();
+
+        return Date::getDatetimeFromTimestamp($timestamp);
+    }
+}

www/analytics/plugins/CoreHome/Columns/UserId.php

@@ -0,0 +1,140 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Cache;
+use Piwik\DataTable;
+use Piwik\DataTable\Map;
+use Piwik\Metrics;
+use Piwik\Piwik;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugin\Segment;
+use Piwik\Plugins\VisitsSummary\API as VisitsSummaryApi;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+
+/**
+ * UserId dimension.
+ */
+class UserId extends VisitDimension
+{
+    /**
+     * @var string
+     */
+    protected $columnName = 'user_id';
+
+    /**
+     * @var string
+     */
+    protected $columnType = 'VARCHAR(200) NULL';
+
+    protected function configureSegments()
+    {
+        $segment = new Segment();
+        $segment->setType('dimension');
+        $segment->setSegment('userId');
+        $segment->setCategory(Piwik::translate('General_Visit'));
+        $segment->setName('General_UserId');
+        $segment->setAcceptedValues('any non empty unique string identifying the user (such as an email address or a username).');
+        $segment->setSqlSegment('log_visit.user_id');
+        $segment->setRequiresAtLeastViewAccess(true);
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed|false
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getForcedUserId();
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     *
+     * @return mixed|false
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getForcedUserId();
+    }
+
+    public function isUsedInAtLeastOneSite($idSites, $period, $date)
+    {
+        if ($period === 'day' || $period === 'week') {
+            $period = 'month';
+        }
+
+        if ($period === 'range') {
+            $period = 'day';
+        }
+
+        foreach ($idSites as $idSite) {
+            if ($this->isUsedInSiteCached($idSite, $period, $date)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    private function isUsedInSiteCached($idSite, $period, $date)
+    {
+        $cache = Cache::getTransientCache();
+        $key   = sprintf('%d.%s.%s', $idSite, $period, $date);
+
+        if (!$cache->contains($key)) {
+            $result = $this->isUsedInSite($idSite, $period, $date);
+            $cache->save($key, $result);
+        }
+
+        return $cache->fetch($key);
+    }
+
+    private function isUsedInSite($idSite, $period, $date)
+    {
+        $result = VisitsSummaryApi::getInstance()->get($idSite, $period, $date, false, 'nb_users');
+
+        return $this->hasDataTableUsers($result);
+    }
+
+    public function hasDataTableUsers(DataTable\DataTableInterface $result)
+    {
+        if ($result instanceof Map) {
+            foreach ($result->getDataTables() as $table) {
+                if ($this->hasDataTableUsers($table)) {
+                    return true;
+                }
+            }
+        }
+
+        if (!$result->getRowsCount()) {
+            return false;
+        }
+
+        $firstRow = $result->getFirstRow();
+        if ($firstRow instanceof DataTable\Row && $firstRow->hasColumn(Metrics::INDEX_NB_USERS)) {
+            $metric = Metrics::INDEX_NB_USERS;
+        } else {
+            $metric = 'nb_users';
+        }
+
+        $numUsers = $result->getColumn($metric);
+        $numUsers = array_sum($numUsers);
+
+        return !empty($numUsers);
+    }
+
+}

www/analytics/plugins/CoreHome/Columns/VisitFirstActionTime.php

@@ -0,0 +1,33 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Date;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker;
+use Piwik\Tracker\Visitor;
+
+class VisitFirstActionTime extends VisitDimension
+{
+    protected $columnName = 'visit_first_action_time';
+    protected $columnType = 'DATETIME NOT NULL';
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return Date::getDatetimeFromTimestamp($request->getCurrentTimestamp());
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitGoalBuyer.php

@@ -0,0 +1,131 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Piwik;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\GoalManager;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitGoalBuyer extends VisitDimension
+{
+    // log_visit.visit_goal_buyer
+    const TYPE_BUYER_NONE = 0;
+    const TYPE_BUYER_ORDERED = 1;
+    const TYPE_BUYER_OPEN_CART = GoalManager::TYPE_BUYER_OPEN_CART;
+    const TYPE_BUYER_ORDERED_AND_OPEN_CART = GoalManager::TYPE_BUYER_ORDERED_AND_OPEN_CART;
+
+    protected static $visitEcommerceStatus = array(
+        self::TYPE_BUYER_NONE                  => 'none',
+        self::TYPE_BUYER_ORDERED               => 'ordered',
+        self::TYPE_BUYER_OPEN_CART             => 'abandonedCart',
+        self::TYPE_BUYER_ORDERED_AND_OPEN_CART => 'orderedThenAbandonedCart',
+    );
+
+    protected $columnName = 'visit_goal_buyer';
+    protected $columnType = 'TINYINT(1) NOT NULL';
+
+    protected function configureSegments()
+    {
+        $example = Piwik::translate('General_EcommerceVisitStatusEg', '"&segment=visitEcommerceStatus==ordered,visitEcommerceStatus==orderedThenAbandonedCart"');
+        $acceptedValues = implode(", ", self::$visitEcommerceStatus) . '. ' . $example;
+
+        $segment = new Segment();
+        $segment->setSegment('visitEcommerceStatus');
+        $segment->setName('General_EcommerceVisitStatusDesc');
+        $segment->setAcceptedValues($acceptedValues);
+        $segment->setSqlFilterValue(__NAMESPACE__ . '\VisitGoalBuyer::getVisitEcommerceStatus');
+
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $this->getBuyerType($request);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        $goalBuyer = $visitor->getVisitorColumn($this->columnName);
+
+        // Ecommerce buyer status
+        $visitEcommerceStatus = $this->getBuyerType($request, $goalBuyer);
+
+        if ($visitEcommerceStatus != self::TYPE_BUYER_NONE
+            // only update if the value has changed (prevents overwriting the value in case a request has
+            // updated it in the meantime)
+            && $visitEcommerceStatus != $goalBuyer) {
+
+            return $visitEcommerceStatus;
+        }
+
+        return false;
+    }
+
+    public static function getVisitEcommerceStatus($status)
+    {
+        $id = array_search($status, self::$visitEcommerceStatus);
+
+        if ($id === false) {
+            throw new \Exception("Invalid 'visitEcommerceStatus' segment value $status");
+        }
+
+        return $id;
+    }
+
+    /**
+     * @ignore
+     */
+    public static function getVisitEcommerceStatusFromId($id)
+    {
+        if (!isset(self::$visitEcommerceStatus[$id])) {
+            throw new \Exception("Unexpected ECommerce status value ");
+        }
+
+        return self::$visitEcommerceStatus[$id];
+    }
+
+    private function getBuyerType(Request $request, $existingType = self::TYPE_BUYER_NONE)
+    {
+        $isRequestEcommerce = $request->getMetadata('Ecommerce', 'isRequestEcommerce');
+        if (!$isRequestEcommerce) {
+            return $existingType;
+        }
+
+        $isGoalAnOrder = $request->getMetadata('Ecommerce', 'isGoalAnOrder');
+        if ($isGoalAnOrder) {
+            return self::TYPE_BUYER_ORDERED;
+        }
+
+        // request is Add to Cart
+        if ($existingType == self::TYPE_BUYER_ORDERED
+            || $existingType == self::TYPE_BUYER_ORDERED_AND_OPEN_CART
+        ) {
+            return self::TYPE_BUYER_ORDERED_AND_OPEN_CART;
+        }
+
+        return self::TYPE_BUYER_OPEN_CART;
+    }
+
+}

www/analytics/plugins/CoreHome/Columns/VisitGoalConverted.php

@@ -0,0 +1,52 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitGoalConverted extends VisitDimension
+{
+    protected $columnName = 'visit_goal_converted';
+    protected $columnType = 'TINYINT(1) NOT NULL';
+
+    protected function configureSegments()
+    {
+        $segment = new Segment();
+        $segment->setSegment('visitConverted');
+        $segment->setName('General_VisitConvertedGoal');
+        $segment->setAcceptedValues('0, 1');
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return 0;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onConvertedVisit(Request $request, Visitor $visitor, $action)
+    {
+        return 1;
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitId.php

@@ -0,0 +1,35 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Piwik;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugin\Segment;
+
+/**
+ * Dimension for the log_visit.idvisit column. This column is added in the CREATE TABLE
+ * statement, so this dimension exists only to configure a segment.
+ */
+class VisitId extends VisitDimension
+{
+    protected function configureSegments()
+    {
+        parent::configureSegments();
+
+        $segment = new Segment();
+        $segment->setType('dimension');
+        $segment->setCategory(Piwik::translate('General_Visit'));
+        $segment->setName(Piwik::translate('General_Visit') . " ID");
+        $segment->setSegment('visitId');
+        $segment->setAcceptedValues('Any integer.');
+        $segment->setSqlSegment('log_visit.idvisit');
+        $segment->setRequiresAtLeastViewAccess(true);
+        $this->addSegment($segment);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitIp.php

@@ -0,0 +1,36 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Piwik;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugin\Segment;
+
+/**
+ * Dimension for the log_visit.location_ip column. This column is added in the CREATE TABLE
+ * statement, so this dimension exists only to configure a segment.
+ */
+class VisitIp extends VisitDimension
+{
+    protected function configureSegments()
+    {
+        parent::configureSegments();
+
+        $segment = new Segment();
+        $segment->setType('metric');
+        $segment->setCategory(Piwik::translate('General_Visit'));
+        $segment->setName('General_VisitorIP');
+        $segment->setSegment('visitIp');
+        $segment->setAcceptedValues('13.54.122.1. </code>Select IP ranges with notation: <code>visitIp>13.54.122.0;visitIp<13.54.122.255');
+        $segment->setSqlSegment('log_visit.location_ip');
+        $segment->setSqlFilterValue(array('Piwik\Network\IPUtils', 'stringToBinaryIP'));
+        $segment->setRequiresAtLeastViewAccess(true);
+        $this->addSegment($segment);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitLastActionTime.php

@@ -0,0 +1,60 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Date;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker;
+use Piwik\Tracker\Visitor;
+
+/**
+ * This dimension holds the best guess for a visit's end time. It is set the last action
+ * time for each visit. `ping=1` requests can be sent to update the dimension value so
+ * it can be a more accurate guess of the time the visitor spent on the site.
+ *
+ * Note: though it is named 'visit last action time' it actually refers to the visit's last action's
+ * end time.
+ */
+class VisitLastActionTime extends VisitDimension
+{
+    protected $columnName = 'visit_last_action_time';
+    // we do not install or define column definition here as we need to create this column when installing as there is
+    // an index on it. Currently we do not define the index here... although we could overwrite the install() method
+    // and add column 'visit_last_action_time' and add index. Problem is there is also an index
+    // INDEX(idsite, config_id, visit_last_action_time) and we maybe not be sure whether idsite already exists at
+    // installing point (we do not know whether idsite column will be added first).
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return Date::getDatetimeFromTimestamp($request->getCurrentTimestamp());
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        if ($request->getParam('ping') == 1) {
+            return false;
+        }
+        
+        return $this->onNewVisit($request, $visitor, $action);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitTotalTime.php

@@ -0,0 +1,108 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Config;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitTotalTime extends VisitDimension
+{
+    protected $columnName = 'visit_total_time';
+    protected $columnType = 'SMALLINT(5) UNSIGNED NOT NULL';
+
+    protected function configureSegments()
+    {
+        $segment = new Segment();
+        $segment->setSegment('visitDuration');
+        $segment->setName('General_ColumnVisitDuration');
+        $segment->setType(Segment::TYPE_METRIC);
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $totalTime = Config::getInstance()->Tracker['default_time_one_page_visit'];
+        $totalTime = $this->cleanupVisitTotalTime($totalTime);
+
+        return $totalTime;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        $firstActionTime = $visitor->getVisitorColumn('visit_first_action_time');
+
+        $totalTime = 1 + $request->getCurrentTimestamp() - $firstActionTime;
+        $totalTime = $this->cleanupVisitTotalTime($totalTime);
+
+        return $totalTime;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onConvertedVisit(Request $request, Visitor $visitor, $action)
+    {
+        if (!$visitor->isVisitorKnown()) {
+            return false;
+        }
+
+        $totalTime = $visitor->getVisitorColumn('visit_total_time');
+
+        // If a pageview and goal conversion in the same second, with previously a goal conversion recorded
+        // the request would not "update" the row since all values are the same as previous
+        // therefore the request below throws exception, instead we make sure the UPDATE will affect the row
+        $totalTime = $totalTime + $request->getParam('idgoal');
+        // +2 to offset idgoal=-1 and idgoal=0
+        $totalTime = $totalTime + 2;
+
+        return $this->cleanupVisitTotalTime($totalTime);
+    }
+
+    public function getRequiredVisitFields()
+    {
+        return array('visit_first_action_time');
+    }
+
+    private function cleanupVisitTotalTime($t)
+    {
+        $t = (int)$t;
+
+        if ($t < 0) {
+            $t = 0;
+        }
+
+        $smallintMysqlLimit = 65534;
+
+        if ($t > $smallintMysqlLimit) {
+            $t = $smallintMysqlLimit;
+        }
+
+        return $t;
+    }
+
+}

www/analytics/plugins/CoreHome/Columns/VisitorDaysSinceFirst.php

@@ -0,0 +1,52 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitorDaysSinceFirst extends VisitDimension
+{
+    protected $columnName = 'visitor_days_since_first';
+    protected $columnType = 'SMALLINT(5) UNSIGNED NOT NULL';
+
+    protected function configureSegments()
+    {
+        $segment = new Segment();
+        $segment->setType(Segment::TYPE_METRIC);
+        $segment->setSegment('daysSinceFirstVisit');
+        $segment->setName('General_DaysSinceFirstVisit');
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getDaysSinceFirstVisit();
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitorDaysSinceOrder.php

@@ -0,0 +1,59 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitorDaysSinceOrder extends VisitDimension
+{
+    protected $columnName = 'visitor_days_since_order';
+    protected $columnType = 'SMALLINT(5) UNSIGNED NOT NULL';
+
+    protected function configureSegments()
+    {
+        $segment = new Segment();
+        $segment->setSegment('daysSinceLastEcommerceOrder');
+        $segment->setName('General_DaysSinceLastEcommerceOrder');
+        $segment->setType(Segment::TYPE_METRIC);
+
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $daysSinceLastOrder = $request->getDaysSinceLastOrder();
+
+        if ($daysSinceLastOrder === false) {
+            $daysSinceLastOrder = 0;
+        }
+
+        return $daysSinceLastOrder;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitorId.php

@@ -0,0 +1,36 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Piwik;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugin\Segment;
+
+/**
+ * Dimension for the log_visit.idvisitor column. This column is added in the CREATE TABLE
+ * statement, so this dimension exists only to configure a segment.
+ */
+class VisitorId extends VisitDimension
+{
+    protected function configureSegments()
+    {
+        parent::configureSegments();
+
+        $segment = new Segment();
+        $segment->setType('dimension');
+        $segment->setCategory(Piwik::translate('General_Visit'));
+        $segment->setName('General_VisitorID');
+        $segment->setSegment('visitorId');
+        $segment->setAcceptedValues('34c31e04394bdc63 - any 16 Hexadecimal chars ID, which can be fetched using the Tracking API function getVisitorId()');
+        $segment->setSqlSegment('log_visit.idvisitor');
+        $segment->setSqlFilterValue(array('Piwik\Common', 'convertVisitorIdToBin'));
+        $segment->setRequiresAtLeastViewAccess(true);
+        $this->addSegment($segment);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitorReturning.php

@@ -0,0 +1,79 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Piwik;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitorReturning extends VisitDimension
+{
+    const IS_RETURNING_CUSTOMER = 2;
+    const IS_RETURNING = 1;
+    const IS_NEW = 0;
+
+    protected $columnName = 'visitor_returning';
+    protected $columnType = 'TINYINT(1) NOT NULL';
+    protected $conversionField = true;
+
+    protected function configureSegments()
+    {
+        $acceptedValues  = 'new, returning, returningCustomer. ';
+        $acceptedValues .= Piwik::translate('General_VisitTypeExample', '"&segment=visitorType==returning,visitorType==returningCustomer"');
+
+        $segment = new Segment();
+        $segment->setSegment('visitorType');
+        $segment->setName('General_VisitType');
+        $segment->setAcceptedValues($acceptedValues);
+        $segment->setSqlFilterValue(function ($type) {
+            return $type == "new" ? 0 : ($type == "returning" ? 1 : 2);
+        });
+
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $visitCount = $request->getVisitCount();
+        $daysSinceLastVisit = $request->getDaysSinceLastVisit();
+
+        $daysSinceLastOrder = $request->getDaysSinceLastOrder();
+        $isReturningCustomer = ($daysSinceLastOrder !== false);
+
+        if ($isReturningCustomer) {
+            return self::IS_RETURNING_CUSTOMER;
+        }
+
+        if ($visitCount > 1 || $visitor->isVisitorKnown() || $daysSinceLastVisit > 0) {
+            return self::IS_RETURNING;
+        }
+
+        return self::IS_NEW;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}

www/analytics/plugins/CoreHome/Columns/VisitsCount.php

@@ -0,0 +1,52 @@
+<?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\CoreHome\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\CoreHome\Segment;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class VisitsCount extends VisitDimension
+{
+    protected $columnName = 'visitor_count_visits';
+    protected $columnType = 'SMALLINT(5) UNSIGNED NOT NULL';
+
+    protected function configureSegments()
+    {
+        $segment = new Segment();
+        $segment->setType(Segment::TYPE_METRIC);
+        $segment->setSegment('visitCount');
+        $segment->setName('General_NumberOfVisits');
+        $this->addSegment($segment);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getVisitCount();
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}