Improve handling of DevicePlugins to make it extendable (#11748)

* Improve handling of DevicePlugins to make it extendable

* update test files

* add some comments to explain automatic plugin column detection

* submodule update

15 files changed, 95 insertions, 47 deletions

diff --git a/plugins/DevicePlugins/Archiver.php b/plugins/DevicePlugins/Archiver.php
index acec8c0cde..1bc8cffa21 100644
--- a/plugins/DevicePlugins/Archiver.php
+++ b/plugins/DevicePlugins/Archiver.php
@@ -12,6 +12,7 @@ namespace Piwik\Plugins\DevicePlugins;
 use Piwik\DataAccess\LogAggregator;
 use Piwik\DataTable;
 use Piwik\Metrics;
+use Piwik\Plugins\DevicePlugins\Columns\DevicePluginColumn;
 
 require_once PIWIK_INCLUDE_PATH . '/plugins/DevicePlugins/functions.php';
 
@@ -52,20 +53,22 @@ class Archiver extends \Piwik\Plugin\Archiver
         );
     }
 
+    /**
+     * Archives reports for all available plugin columns
+     * @see DevicePluginColumn
+     */
     protected function aggregateByPlugin()
     {
-        $selects = array(
-            "sum(case log_visit.config_pdf when 1 then 1 else 0 end) as pdf",
-            "sum(case log_visit.config_flash when 1 then 1 else 0 end) as flash",
-            "sum(case log_visit.config_java when 1 then 1 else 0 end) as java",
-            "sum(case log_visit.config_director when 1 then 1 else 0 end) as director",
-            "sum(case log_visit.config_quicktime when 1 then 1 else 0 end) as quicktime",
-            "sum(case log_visit.config_realplayer when 1 then 1 else 0 end) as realplayer",
-            "sum(case log_visit.config_windowsmedia when 1 then 1 else 0 end) as windowsmedia",
-            "sum(case log_visit.config_gears when 1 then 1 else 0 end) as gears",
-            "sum(case log_visit.config_silverlight when 1 then 1 else 0 end) as silverlight",
-            "sum(case log_visit.config_cookie when 1 then 1 else 0 end) as cookie"
-        );
+        $selects = array();
+        $columns = DevicePlugins::getAllPluginColumns();
+
+        foreach ($columns as $column) {
+            $selects[] = sprintf(
+                "sum(case log_visit.%s when 1 then 1 else 0 end) as %s",
+                $column->getColumnName(),
+                substr($column->getColumnName(), 7) // remove leading `config_`
+            );
+        }
 
         $query = $this->getLogAggregator()->queryVisitsByDimension(array(), false, $selects, $metrics = array());
         $data = $query->fetch();
diff --git a/plugins/DevicePlugins/Columns/DevicePluginColumn.php b/plugins/DevicePlugins/Columns/DevicePluginColumn.php
new file mode 100644
index 0000000000..a122b3887d
--- /dev/null
+++ b/plugins/DevicePlugins/Columns/DevicePluginColumn.php
@@ -0,0 +1,21 @@
+<?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\DevicePlugins\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+
+/**
+ * Columns extending this class will be automatically considered as new browser plugin
+ *
+ * Note: The column name needs to start with `config_` to be handled correctly
+ */
+abstract class DevicePluginColumn extends VisitDimension
+{
+
+}
\ No newline at end of file
diff --git a/plugins/DevicePlugins/Columns/PluginCookie.php b/plugins/DevicePlugins/Columns/PluginCookie.php
index f5c88a1dc2..19dd1e226d 100644
--- a/plugins/DevicePlugins/Columns/PluginCookie.php
+++ b/plugins/DevicePlugins/Columns/PluginCookie.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginCookie extends VisitDimension
+class PluginCookie extends DevicePluginColumn
 {
     protected $columnName = 'config_cookie';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginDirector.php b/plugins/DevicePlugins/Columns/PluginDirector.php
index e1a60bb92a..b1b479d92d 100644
--- a/plugins/DevicePlugins/Columns/PluginDirector.php
+++ b/plugins/DevicePlugins/Columns/PluginDirector.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginDirector extends VisitDimension
+class PluginDirector extends DevicePluginColumn
 {
     protected $columnName = 'config_director';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginFlash.php b/plugins/DevicePlugins/Columns/PluginFlash.php
index 448a02a9b1..e307ef0c84 100644
--- a/plugins/DevicePlugins/Columns/PluginFlash.php
+++ b/plugins/DevicePlugins/Columns/PluginFlash.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginFlash extends VisitDimension
+class PluginFlash extends DevicePluginColumn
 {
     protected $columnName = 'config_flash';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginGears.php b/plugins/DevicePlugins/Columns/PluginGears.php
index f6e2e0aa61..c0845f0904 100644
--- a/plugins/DevicePlugins/Columns/PluginGears.php
+++ b/plugins/DevicePlugins/Columns/PluginGears.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginGears extends VisitDimension
+class PluginGears extends DevicePluginColumn
 {
     protected $columnName = 'config_gears';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginJava.php b/plugins/DevicePlugins/Columns/PluginJava.php
index 351328ce17..bd9877a1b5 100644
--- a/plugins/DevicePlugins/Columns/PluginJava.php
+++ b/plugins/DevicePlugins/Columns/PluginJava.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginJava extends VisitDimension
+class PluginJava extends DevicePluginColumn
 {
     protected $columnName = 'config_java';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginPdf.php b/plugins/DevicePlugins/Columns/PluginPdf.php
index 1a9a22dc21..bd1fccfad3 100644
--- a/plugins/DevicePlugins/Columns/PluginPdf.php
+++ b/plugins/DevicePlugins/Columns/PluginPdf.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginPdf extends VisitDimension
+class PluginPdf extends DevicePluginColumn
 {
     protected $columnName = 'config_pdf';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginQuickTime.php b/plugins/DevicePlugins/Columns/PluginQuickTime.php
index 8626adbfb2..a203dedccb 100644
--- a/plugins/DevicePlugins/Columns/PluginQuickTime.php
+++ b/plugins/DevicePlugins/Columns/PluginQuickTime.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginQuickTime extends VisitDimension
+class PluginQuickTime extends DevicePluginColumn
 {
     protected $columnName = 'config_quicktime';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginRealPlayer.php b/plugins/DevicePlugins/Columns/PluginRealPlayer.php
index baeadb4b4c..d805aafccd 100644
--- a/plugins/DevicePlugins/Columns/PluginRealPlayer.php
+++ b/plugins/DevicePlugins/Columns/PluginRealPlayer.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginRealPlayer extends VisitDimension
+class PluginRealPlayer extends DevicePluginColumn
 {
     protected $columnName = 'config_realplayer';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginSilverlight.php b/plugins/DevicePlugins/Columns/PluginSilverlight.php
index e3b62cd409..897d2939da 100644
--- a/plugins/DevicePlugins/Columns/PluginSilverlight.php
+++ b/plugins/DevicePlugins/Columns/PluginSilverlight.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginSilverlight extends VisitDimension
+class PluginSilverlight extends DevicePluginColumn
 {
     protected $columnName = 'config_silverlight';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/Columns/PluginWindowsMedia.php b/plugins/DevicePlugins/Columns/PluginWindowsMedia.php
index 569133ba04..99e25f4bdc 100644
--- a/plugins/DevicePlugins/Columns/PluginWindowsMedia.php
+++ b/plugins/DevicePlugins/Columns/PluginWindowsMedia.php
@@ -9,12 +9,11 @@
 namespace Piwik\Plugins\DevicePlugins\Columns;
 
 use Piwik\Common;
-use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Tracker\Request;
 use Piwik\Tracker\Visitor;
 use Piwik\Tracker\Action;
 
-class PluginWindowsMedia extends VisitDimension
+class PluginWindowsMedia extends DevicePluginColumn
 {
     protected $columnName = 'config_windowsmedia';
     protected $columnType = 'TINYINT(1) NULL';
diff --git a/plugins/DevicePlugins/DevicePlugins.php b/plugins/DevicePlugins/DevicePlugins.php
index a41a2aeb9d..fdf91ff464 100644
--- a/plugins/DevicePlugins/DevicePlugins.php
+++ b/plugins/DevicePlugins/DevicePlugins.php
@@ -8,9 +8,10 @@
  */
 namespace Piwik\Plugins\DevicePlugins;
 
+use Piwik\Cache;
+use Piwik\CacheId;
 use Piwik\Piwik;
-use Piwik\Plugins\CoreVisualizations\Visualizations\Graph;
-use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
+use Piwik\Plugin;
 
 /**
  *
@@ -18,7 +19,7 @@ use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
 class DevicePlugins extends \Piwik\Plugin
 {
     /**
-     * @see Piwik\Plugin::registerEvents
+     * @see Plugin::registerEvents
      */
     public function registerEvents()
     {
@@ -44,4 +45,40 @@ class DevicePlugins extends \Piwik\Plugin
 
         $translations = array_merge($translations, $metrics);
     }
+
+
+    /**
+     * Returns all available DevicePlugins Columns
+     *
+     * @return Columns\DevicePluginColumn[]
+     * @throws \Exception
+     */
+    public static function getAllPluginColumns()
+    {
+        $cacheId = CacheId::pluginAware('DevicePluginColumns');
+        $cache   = Cache::getTransientCache();
+
+        if (!$cache->contains($cacheId)) {
+            $instances = [];
+
+            foreach (self::getAllDevicePluginsColumnClasses() as $className) {
+                $instance = new $className();
+                $instances[] = $instance;
+            }
+            $cache->save($cacheId, $instances);
+        }
+
+        return $cache->fetch($cacheId);
+    }
+
+    /**
+     * Returns class names of all DevicePlugins Column classes.
+     *
+     * @return string[]
+     * @api
+     */
+    protected static function getAllDevicePluginsColumnClasses()
+    {
+        return Plugin\Manager::getInstance()->findMultipleComponents('Columns', 'Piwik\Plugins\DevicePlugins\Columns\DevicePluginColumn');
+    }
 }
diff --git a/plugins/DevicePlugins/Reports/GetPlugin.php b/plugins/DevicePlugins/Reports/GetPlugin.php
index 42fef1cb89..a2c6dad79a 100644
--- a/plugins/DevicePlugins/Reports/GetPlugin.php
+++ b/plugins/DevicePlugins/Reports/GetPlugin.php
@@ -11,6 +11,7 @@ namespace Piwik\Plugins\DevicePlugins\Reports;
 use Piwik\Piwik;
 use Piwik\Plugin\ViewDataTable;
 use Piwik\Plugins\DevicePlugins\Columns\Plugin;
+use Piwik\Plugins\DevicePlugins\DevicePlugins;
 
 class GetPlugin extends Base
 {
@@ -48,7 +49,7 @@ class GetPlugin extends Base
 
         $view->requestConfig->filter_sort_column = 'nb_visits_percentage';
         $view->requestConfig->filter_sort_order  = 'desc';
-        $view->requestConfig->filter_limit       = 10;
+        $view->requestConfig->filter_limit       = count(DevicePlugins::getAllPluginColumns());
     }
 
 }
diff --git a/plugins/DevicePlugins/Visitor.php b/plugins/DevicePlugins/Visitor.php
index 501e241a50..d254265974 100644
--- a/plugins/DevicePlugins/Visitor.php
+++ b/plugins/DevicePlugins/Visitor.php
@@ -23,17 +23,13 @@ class Visitor
 
     function getPlugins()
     {
-        $plugins = array(
-            'config_pdf',
-            'config_flash',
-            'config_java',
-            'config_director',
-            'config_quicktime',
-            'config_realplayer',
-            'config_windowsmedia',
-            'config_gears',
-            'config_silverlight',
-        );
+        $plugins = array();
+        $columns = DevicePlugins::getAllPluginColumns();
+
+        foreach ($columns as $column) {
+            $plugins[] = $column->getColumnName();
+        }
+
         $pluginShortNames = array();
 
         foreach ($plugins as $plugin) {