Include CustomDimensions plugin in core (#16086)

2 files changed, 200 insertions, 0 deletions

diff --git a/plugins/CustomDimensions b/plugins/CustomDimensions
deleted file mode 160000
-Subproject 318661a2fb1ef3b3e5d6d999ae8b9628cb5a113
diff --git a/plugins/CustomDimensions/Tracker/CustomDimensionsRequestProcessor.php b/plugins/CustomDimensions/Tracker/CustomDimensionsRequestProcessor.php
new file mode 100644
index 0000000000..87ceccd563
--- /dev/null
+++ b/plugins/CustomDimensions/Tracker/CustomDimensionsRequestProcessor.php
@@ -0,0 +1,200 @@
+<?php
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\CustomDimensions\Tracker;
+
+use Piwik\Common;
+use Piwik\Plugins\CustomDimensions\CustomDimensions;
+use Piwik\Plugins\CustomDimensions\Dao;
+use Piwik\Plugins\CustomDimensions\Dimension\Extraction;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Cache;
+use Piwik\Tracker\Model;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\RequestProcessor;
+use Piwik\Tracker\Visit\VisitProperties;
+use Piwik\Url;
+
+/**
+ * Handles tracking of custom dimensions
+ */
+class CustomDimensionsRequestProcessor extends RequestProcessor
+{
+
+    public function recordLogs(VisitProperties $visitProperties, Request $request)
+    {
+        if (!self::hasActionCustomDimensionConfiguredInSite($request)) {
+            return;
+        }
+
+        $model = new Model();
+
+        /** @var Action $action */
+        $action = $request->getMetadata('Actions', 'action');
+
+        if (!empty($action)) {
+            $idLinkVisit = $action->getIdLinkVisitAction();
+            $idVisit     = $visitProperties->getProperty('idvisit');
+            $model->updateVisit($request->getIdSite(), $idVisit, array('last_idlink_va' => $idLinkVisit));
+        }
+
+        $lastIdLinkVa = $visitProperties->getProperty('last_idlink_va');
+        $timeSpent    = $visitProperties->getProperty('time_spent_ref_action');
+
+        if (!empty($lastIdLinkVa) && $timeSpent > 0) {
+            $model->updateAction($lastIdLinkVa, array('time_spent' => $timeSpent));
+        }
+    }
+
+    public static function hasActionCustomDimensionConfiguredInSite($request)
+    {
+        $dimensions = self::getCachedCustomDimensions($request);
+        if (empty($dimensions)) {
+            return false;
+        }
+        foreach ($dimensions as $dimension) {
+            if ($dimension['scope'] == CustomDimensions::SCOPE_ACTION) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public function onNewVisit(VisitProperties $visitProperties, Request $request)
+    {
+        $dimensionsToSet = $this->getCustomDimensionsInScope(CustomDimensions::SCOPE_VISIT, $request);
+
+        foreach ($dimensionsToSet as $field => $value) {
+            $visitProperties->setProperty($field, $value);
+        }
+    }
+
+    public function onExistingVisit(&$valuesToUpdate, VisitProperties $visitProperties, Request $request)
+    {
+        $dimensionsToSet = $this->getCustomDimensionsInScope(CustomDimensions::SCOPE_VISIT, $request);
+
+        foreach ($dimensionsToSet as $field => $value) {
+            $valuesToUpdate[$field] = $value;
+            $visitProperties->setProperty($field, $value);
+        }
+    }
+
+    public function afterRequestProcessed(VisitProperties $visitProperties, Request $request)
+    {
+        $action = $request->getMetadata('Actions', 'action');
+
+        if (empty($action) || !($action instanceof Action)) {
+            return;
+        }
+
+        $dimensionsToSet = $this->getCustomDimensionsInScope(CustomDimensions::SCOPE_ACTION, $request);
+
+        foreach ($dimensionsToSet as $field => $value) {
+            $action->setCustomField($field, $value);
+        }
+    }
+
+    private function getCustomDimensionsInScope($scope, Request $request)
+    {
+        $dimensions = self::getCachedCustomDimensions($request);
+        $params = $request->getParams();
+
+        $values = array();
+
+        foreach ($dimensions as $dimension) {
+            if ($dimension['scope'] !== $scope) {
+                continue;
+            }
+
+            $field = self::buildCustomDimensionTrackingApiName($dimension);
+            $dbField = Dao\LogTable::buildCustomDimensionColumnName($dimension);
+
+            $value = Common::getRequestVar($field, '', 'string', $params);
+            $hasSentEmptyString = isset($params[$field]) && $params[$field] === '';
+            if ($value !== '' || $hasSentEmptyString) {
+                $values[$dbField] = self::prepareValue($value);
+                continue;
+            }
+
+            $extractions = $dimension['extractions'];
+            if (is_array($extractions)) {
+                foreach ($extractions as $extraction) {
+                    if (!array_key_exists('dimension', $extraction)
+                     || !array_key_exists('pattern', $extraction)
+                     || empty($extraction['pattern'])) {
+                        continue;
+                    }
+
+                    $extraction = new Extraction($extraction['dimension'], $extraction['pattern']);
+                    $extraction->setCaseSensitive($dimension['case_sensitive']);
+                    $value = $extraction->extract($request);
+
+                    if (!isset($value) || '' === $value) {
+                        continue;
+                    }
+
+                    $values[$dbField] = self::prepareValue(urldecode($value));
+                    break;
+                }
+            }
+        }
+
+        return $values;
+    }
+
+    private static function prepareValue($value)
+    {
+        return Common::mb_substr(trim($value), 0, 250);
+    }
+
+    public static function buildCustomDimensionTrackingApiName($idDimensionOrDimension)
+    {
+        if (is_array($idDimensionOrDimension) && isset($idDimensionOrDimension['idcustomdimension'])) {
+            $idDimensionOrDimension = $idDimensionOrDimension['idcustomdimension'];
+        }
+
+        $idDimensionOrDimension = (int) $idDimensionOrDimension;
+
+        if ($idDimensionOrDimension >= 1) {
+            return 'dimension' . (int) $idDimensionOrDimension;
+        }
+    }
+
+    public static function getCachedCustomDimensionIndexes($scope)
+    {
+        $cache = Cache::getCacheGeneral();
+        $key = 'custom_dimension_indexes_installed_' . $scope;
+
+        if (empty($cache[$key])) {
+            return array();
+        }
+
+        return $cache[$key];
+    }
+
+    /**
+     * Get Cached Custom Dimensions during tracking. Returns only active custom dimensions.
+     *
+     * @param Request $request
+     * @return array
+     * @throws \Piwik\Exception\UnexpectedWebsiteFoundException
+     */
+    public static function getCachedCustomDimensions(Request $request)
+    {
+        $idSite = $request->getIdSite();
+        $cache  = Cache::getCacheWebsiteAttributes($idSite);
+
+        if (empty($cache['custom_dimensions'])) {
+            // no custom dimensions set
+            return array();
+        }
+
+        return $cache['custom_dimensions'];
+    }
+
+}