From 62b81dc916c3b80634669ce1b2068286125aae34 Mon Sep 17 00:00:00 2001
From: Lukas Winkler <git@lw1.at>
Date: Sun, 24 May 2020 11:14:21 +0200
Subject: [PATCH] complete WIP

---
 BotTracking.php         | 51 +++++++++++++++++++++++++
 CHANGELOG.md            |  3 ++
 Columns/BotCategory.php | 71 ++++++++++++++++++++++++++++++++++
 Columns/BotName.php     | 71 ++++++++++++++++++++++++++++++++++
 Columns/BotProducer.php | 84 +++++++++++++++++++++++++++++++++++++++++
 README.md               |  6 +++
 config/config.php       |  2 +
 config/tracker.php      |  2 +
 docs/faq.md             |  5 +++
 docs/index.md           |  1 +
 lang/en.json            |  5 +++
 plugin.json             | 30 +++++++++++++++
 screenshots/.gitkeep    |  0
 13 files changed, 331 insertions(+)
 create mode 100644 BotTracking.php
 create mode 100644 CHANGELOG.md
 create mode 100644 Columns/BotCategory.php
 create mode 100644 Columns/BotName.php
 create mode 100644 Columns/BotProducer.php
 create mode 100644 README.md
 create mode 100644 config/config.php
 create mode 100644 config/tracker.php
 create mode 100644 docs/faq.md
 create mode 100644 docs/index.md
 create mode 100644 lang/en.json
 create mode 100644 plugin.json
 create mode 100644 screenshots/.gitkeep

diff --git a/BotTracking.php b/BotTracking.php
new file mode 100644
index 0000000..858bd52
--- /dev/null
+++ b/BotTracking.php
@@ -0,0 +1,51 @@
+<?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\BotTracking;
+
+use DeviceDetector\DeviceDetector;
+use Piwik\Common;
+use Piwik\DeviceDetector\DeviceDetectorCache;
+use Piwik\Plugin;
+use Piwik\Tracker\Request;
+
+class BotTracking extends Plugin
+{
+
+    public function registerEvents()
+    {
+        return array(
+            'Tracker.isExcludedVisit' => 'isExcludedVisit'
+        );
+    }
+
+    public function isTrackerPlugin()
+    {
+        return true;
+    }
+
+    public function isExcludedVisit(bool &$excluded, Request $request)
+    {
+        $userAgent = $request->getUserAgent();
+        $userAgent = Common::unsanitizeInputValue($userAgent);
+//        $deviceDetector = StaticContainer::get(DeviceDetectorFactory::class)->makeInstance($userAgent);
+        // create new DeviceDetector with full data
+        $deviceDetector = new DeviceDetector($userAgent);
+        $deviceDetector->setCache(new DeviceDetectorCache(86400));
+        $deviceDetector->parse();
+        $isBot = $deviceDetector->isBot();
+        if ($isBot) {
+            $request->setMetadata("BotTracking", "isBot", $deviceDetector->isBot());
+            $botMeta = $deviceDetector->getBot();
+            $request->setMetadata("BotTracking", "botName", $botMeta["name"]);
+            $request->setMetadata("BotTracking", "botCategory", $botMeta["category"]);
+            $request->setMetadata("BotTracking", "botProducer", $botMeta["producer"]["name"]);
+            $excluded = false;
+        }
+    }
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..8546318
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## Changelog
+
+Here goes the changelog text.
diff --git a/Columns/BotCategory.php b/Columns/BotCategory.php
new file mode 100644
index 0000000..8a6c866
--- /dev/null
+++ b/Columns/BotCategory.php
@@ -0,0 +1,71 @@
+<?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\BotTracking\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class BotCategory extends VisitDimension
+{
+    /**
+     * This will be the name of the column in the log_visit table if a $columnType is specified.
+     * @var string
+     */
+    protected $columnName = 'bot_category';
+
+    /**
+     * If a columnType is defined, we will create this a column in the MySQL table having this type. Please make sure
+     * MySQL will understand this type. Once you change the column type the Piwik platform will notify the user to
+     * perform an update which can sometimes take a long time so be careful when choosing the correct column type.
+     * @var string
+     */
+    protected $columnType = "VARCHAR(255)";
+
+    /**
+     * The type of the dimension is automatically detected by the columnType. If the type of the dimension is not
+     * detected correctly, you may want to adjust the type manually. The configured type will affect how the dimension
+     * is formatted in the UI.
+     * @var string
+     */
+    protected $type = self::TYPE_TEXT;
+
+    /**
+     * The name of the dimension which will be visible for instance in the UI of a related report and in the mobile app.
+     * @return string
+     */
+    protected $nameSingular = 'BotTracking_BotCategory';
+
+    /**
+     * By defining a segment a user will be able to filter their visitors by this column. For instance
+     * show all reports only considering users having more than 10 achievement points. If you do not want to define a
+     * segment for this dimension, simply leave the name empty.
+     */
+    protected $segmentName = 'botCategory';
+
+    protected $acceptValues = 'Here you should explain which values are accepted/useful for segments: Any number, for instance 1, 2, 3 , 99';
+
+    /**
+     * The onNewVisit method is triggered when a new visitor is detected. This means here you can define an initial
+     * value for this user. By returning boolean false no value will be saved. Once the user makes another action the
+     * event "onExistingVisit" is executed. That means for each visitor this method is executed once. If you do not want
+     * to perform any action on a new visit you can just remove this method.
+     *
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed|false
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getMetadata("BotTracking", "botCategory");
+    }
+}
diff --git a/Columns/BotName.php b/Columns/BotName.php
new file mode 100644
index 0000000..f51f677
--- /dev/null
+++ b/Columns/BotName.php
@@ -0,0 +1,71 @@
+<?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\BotTracking\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class BotName extends VisitDimension
+{
+    /**
+     * This will be the name of the column in the log_visit table if a $columnType is specified.
+     * @var string
+     */
+    protected $columnName = 'bot_name';
+
+    /**
+     * If a columnType is defined, we will create this a column in the MySQL table having this type. Please make sure
+     * MySQL will understand this type. Once you change the column type the Piwik platform will notify the user to
+     * perform an update which can sometimes take a long time so be careful when choosing the correct column type.
+     * @var string
+     */
+    protected $columnType = "VARCHAR(255)";
+
+    /**
+     * The type of the dimension is automatically detected by the columnType. If the type of the dimension is not
+     * detected correctly, you may want to adjust the type manually. The configured type will affect how the dimension
+     * is formatted in the UI.
+     * @var string
+     */
+    protected $type = self::TYPE_TEXT;
+
+    /**
+     * The name of the dimension which will be visible for instance in the UI of a related report and in the mobile app.
+     * @return string
+     */
+    protected $nameSingular = 'BotTracking_BotName';
+
+    /**
+     * By defining a segment a user will be able to filter their visitors by this column. For instance
+     * show all reports only considering users having more than 10 achievement points. If you do not want to define a
+     * segment for this dimension, simply leave the name empty.
+     */
+    protected $segmentName = 'botName';
+
+    protected $acceptValues = 'Here you should explain which values are accepted/useful for segments: Any number, for instance 1, 2, 3 , 99';
+
+    /**
+     * The onNewVisit method is triggered when a new visitor is detected. This means here you can define an initial
+     * value for this user. By returning boolean false no value will be saved. Once the user makes another action the
+     * event "onExistingVisit" is executed. That means for each visitor this method is executed once. If you do not want
+     * to perform any action on a new visit you can just remove this method.
+     *
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed|false
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getMetadata("BotTracking", "botName");
+    }
+}
diff --git a/Columns/BotProducer.php b/Columns/BotProducer.php
new file mode 100644
index 0000000..21d815d
--- /dev/null
+++ b/Columns/BotProducer.php
@@ -0,0 +1,84 @@
+<?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\BotTracking\Columns;
+
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+
+class BotProducer extends VisitDimension
+{
+    /**
+     * This will be the name of the column in the log_visit table if a $columnType is specified.
+     * @var string
+     */
+    protected $columnName = 'bot_producer';
+
+    /**
+     * If a columnType is defined, we will create this a column in the MySQL table having this type. Please make sure
+     * MySQL will understand this type. Once you change the column type the Piwik platform will notify the user to
+     * perform an update which can sometimes take a long time so be careful when choosing the correct column type.
+     * @var string
+     */
+    protected $columnType = "VARCHAR(255)";
+
+    /**
+     * The type of the dimension is automatically detected by the columnType. If the type of the dimension is not
+     * detected correctly, you may want to adjust the type manually. The configured type will affect how the dimension
+     * is formatted in the UI.
+     * @var string
+     */
+    protected $type = self::TYPE_TEXT;
+
+    /**
+     * The name of the dimension which will be visible for instance in the UI of a related report and in the mobile app.
+     * @return string
+     */
+    protected $nameSingular = 'BotTracking_BotProducer';
+
+    /**
+     * By defining a segment a user will be able to filter their visitors by this column. For instance
+     * show all reports only considering users having more than 10 achievement points. If you do not want to define a
+     * segment for this dimension, simply leave the name empty.
+     */
+    protected $segmentName = 'botProducer';
+
+    protected $acceptValues = 'Here you should explain which values are accepted/useful for segments: Any number, for instance 1, 2, 3 , 99';
+
+    /**
+     * The onNewVisit method is triggered when a new visitor is detected. This means here you can define an initial
+     * value for this user. By returning boolean false no value will be saved. Once the user makes another action the
+     * event "onExistingVisit" is executed. That means for each visitor this method is executed once. If you do not want
+     * to perform any action on a new visit you can just remove this method.
+     *
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed|false
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $request->getMetadata("BotTracking", "botProducer");
+    }
+
+
+    /**
+     * Sometimes you may want to make sure another dimension is executed before your dimension so you can persist
+     * a value depending on the value of other dimensions. You can do this by defining an array of dimension names.
+     * If you access any value of any other column within your events, you should require them here. Otherwise those
+     * values may not be available.
+     * @return array
+     * public function getRequiredVisitFields()
+     * {
+     * return array('idsite', 'server_time');
+     * }
+     */
+}
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..26a3294
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+# Matomo BotTracking Plugin
+
+## Description
+
+Add your plugin description here.
+
diff --git a/config/config.php b/config/config.php
new file mode 100644
index 0000000..d266508
--- /dev/null
+++ b/config/config.php
@@ -0,0 +1,2 @@
+<?php
+return array();
diff --git a/config/tracker.php b/config/tracker.php
new file mode 100644
index 0000000..ca2affe
--- /dev/null
+++ b/config/tracker.php
@@ -0,0 +1,2 @@
+<?php 
+return array(); 
diff --git a/docs/faq.md b/docs/faq.md
new file mode 100644
index 0000000..dde17aa
--- /dev/null
+++ b/docs/faq.md
@@ -0,0 +1,5 @@
+## FAQ
+
+__My question?__
+
+My answer
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..70135e8
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1 @@
+## Documentation
\ No newline at end of file
diff --git a/lang/en.json b/lang/en.json
new file mode 100644
index 0000000..6cb77b1
--- /dev/null
+++ b/lang/en.json
@@ -0,0 +1,5 @@
+{
+    "BotTracking": {
+        "BotName": "BotName"
+    }
+}
\ No newline at end of file
diff --git a/plugin.json b/plugin.json
new file mode 100644
index 0000000..2e64136
--- /dev/null
+++ b/plugin.json
@@ -0,0 +1,30 @@
+{
+    "name": "BotTracking",
+    "description": "Track statistics exclusivly about bots",
+    "version": "0.1.0",
+    "theme": false,
+    "require": {
+        "matomo": ">=4.0.0-b1,<5.0.0-b1",
+        "piwik": ">=4.0.0-b2,<5.0.0-b1"
+    },
+    "authors": [
+        {
+            "name": "Matomo",
+            "email": "",
+            "homepage": ""
+        }
+    ],
+    "support": {
+        "email": "",
+        "issues": "",
+        "forum": "",
+        "irc": "",
+        "wiki": "",
+        "source": "",
+        "docs": "",
+        "rss": ""
+    },
+    "homepage": "",
+    "license": "GPL v3+",
+    "keywords": []
+}
\ No newline at end of file
diff --git a/screenshots/.gitkeep b/screenshots/.gitkeep
new file mode 100644
index 0000000..e69de29