Merge pull request #8317 from piwik/8071_tracker_req_handler

Refs #8071, refactor tracker code for clarity, modularity and so plugins can have more granular control over tracking. Introduce RequestProcessor & request metadata concepts & use to split up Visit::handle() method so tracking logic is located in the relevant plugins.

config/global.ini.php

@@ -777,6 +777,7 @@
 Plugins[] = BulkTracking
 Plugins[] = Resolution
 Plugins[] = DevicePlugins
+Plugins[] = Heartbeat
 Plugins[] = Intl
 
 [PluginsInstalled]

config/global.php

@@ -72,4 +72,17 @@
                 'tld' => false,
             ))));
     },
+
+    // contains RequestProcessor instances, currently used by Piwik\Tracker\Visit
+    'tracker.request.processors' => array(),
+
+    'Piwik\Tracker\VisitorRecognizer' => DI\object()
+        ->constructorParameter('trustCookiesOnly', DI\get('ini.Tracker.trust_visitors_cookies'))
+        ->constructorParameter('visitStandardLength', DI\get('ini.Tracker.visit_standard_length'))
+        ->constructorParameter('lookbackNSecondsCustom', DI\get('ini.Tracker.window_look_back_for_visitor'))
+        ->constructorParameter('trackerAlwaysNewVisitor', DI\get('ini.Debug.tracker_always_new_visitor')),
+
+    'Piwik\Tracker\Settings' => DI\object()
+        ->constructorParameter('isSameFingerprintsAcrossWebsites', DI\get('ini.Tracker.enable_fingerprinting_across_websites')),
+
 );

core/API/DocumentationGenerator.php

@@ -290,6 +290,7 @@ public function getExampleUrl($class, $methodName, $parametersToSet = array())
         $aParameters['pivotByColumnLimit'] = false;
         $aParameters['disable_queued_filters'] = false;
         $aParameters['disable_generic_filters'] = false;
+        $aParameters['expanded'] = false;
 
         $moduleName = Proxy::getInstance()->getModuleNameFromClassName($class);
         $aParameters = array_merge(array('module' => 'API', 'method' => $moduleName . '.' . $methodName), $aParameters);

core/Plugin.php

@@ -450,6 +450,20 @@ public static function getPluginNameFromNamespace($namespaceOrClassName)
         }
     }
 
+    /**
+     * Override this method in your plugin class if you want your plugin to be loaded during tracking.
+     *
+     * Note: If you define your own dimension or handle a tracker event, your plugin will automatically
+     * be detected as a tracker plugin.
+     *
+     * @return bool
+     * @internal
+     */
+    public function isTrackerPlugin()
+    {
+        return false;
+    }
+
     /**
      * @param $directoryWithinPlugin
      * @param $expectedSubclass

core/Plugin/Manager.php

@@ -1102,6 +1102,10 @@ public function isTrackerPlugin(Plugin $plugin)
             return true;
         }
 
+        if ($plugin->isTrackerPlugin()) {
+            return true;
+        }
+
         return false;
     }