From 8eaa5e866a65730f0906ec60182f53d9c42bacaf Mon Sep 17 00:00:00 2001
From: Thomas Steur <tsteur@users.noreply.github.com>
Date: Mon, 24 Sep 2018 16:15:30 +1200
Subject: [PATCH] Add possibility to manage and view Intranet websites #7724

---
 config/global.ini.php                         |  1 +
 core/Tracker/Visit.php                        |  6 ---
 core/Tracker/VisitorRecognizer.php            |  5 ++
 core/Updates/3.6.1-b2.php                     |  1 +
 .../IntranetMeasurable/IntranetMeasurable.php | 46 +++++++++++++++++++
 .../IntranetMeasurable/MeasurableSettings.php | 39 ++++++++++++++++
 .../Tracker/RequestProcessor.php              | 37 +++++++++++++++
 plugins/IntranetMeasurable/Type.php           | 20 ++++++++
 plugins/IntranetMeasurable/lang/en.json       |  9 ++++
 plugins/IntranetMeasurable/plugin.json        |  4 ++
 plugins/SitesManager/SitesManager.php         |  1 +
 11 files changed, 163 insertions(+), 6 deletions(-)
 create mode 100644 plugins/IntranetMeasurable/IntranetMeasurable.php
 create mode 100644 plugins/IntranetMeasurable/MeasurableSettings.php
 create mode 100644 plugins/IntranetMeasurable/Tracker/RequestProcessor.php
 create mode 100644 plugins/IntranetMeasurable/Type.php
 create mode 100644 plugins/IntranetMeasurable/lang/en.json
 create mode 100644 plugins/IntranetMeasurable/plugin.json

diff --git a/config/global.ini.php b/config/global.ini.php
index 17df3416821..fe3168065be 100644
--- a/config/global.ini.php
+++ b/config/global.ini.php
@@ -868,6 +868,7 @@
 Plugins[] = CoreAdminHome
 Plugins[] = CoreHome
 Plugins[] = WebsiteMeasurable
+Plugins[] = IntranetMeasurable
 Plugins[] = Diagnostics
 Plugins[] = CoreVisualizations
 Plugins[] = Proxy
diff --git a/core/Tracker/Visit.php b/core/Tracker/Visit.php
index 06382c26d72..737c24c380f 100644
--- a/core/Tracker/Visit.php
+++ b/core/Tracker/Visit.php
@@ -65,11 +65,6 @@ class Visit implements VisitInterface
      */
     protected $visitProperties;
 
-    /**
-     * @var VisitorRecognizer
-     */
-    private $visitorRecognizer;
-
     /**
      * @var ArchiveInvalidator
      */
@@ -79,7 +74,6 @@ public function __construct()
     {
         $requestProcessors = StaticContainer::get('Piwik\Plugin\RequestProcessors');
         $this->requestProcessors = $requestProcessors->getRequestProcessors();
-        $this->visitorRecognizer = StaticContainer::get('Piwik\Tracker\VisitorRecognizer');
         $this->visitProperties = null;
         $this->userSettings = StaticContainer::get('Piwik\Tracker\Settings');
         $this->invalidator = StaticContainer::get('Piwik\Archive\ArchiveInvalidator');
diff --git a/core/Tracker/VisitorRecognizer.php b/core/Tracker/VisitorRecognizer.php
index 7727156727a..4b3be310a2a 100644
--- a/core/Tracker/VisitorRecognizer.php
+++ b/core/Tracker/VisitorRecognizer.php
@@ -77,6 +77,11 @@ public function __construct($trustCookiesOnly, $visitStandardLength, $lookbackNS
         $this->eventDispatcher = $eventDispatcher;
     }
 
+    public function setTrustCookiesOnly($trustCookiesOnly)
+    {
+        $this->trustCookiesOnly = $trustCookiesOnly;
+    }
+
     public function findKnownVisitor($configId, VisitProperties $visitProperties, Request $request)
     {
         $idSite    = $request->getIdSite();
diff --git a/core/Updates/3.6.1-b2.php b/core/Updates/3.6.1-b2.php
index 1236c0f167e..70ed561b28f 100644
--- a/core/Updates/3.6.1-b2.php
+++ b/core/Updates/3.6.1-b2.php
@@ -33,6 +33,7 @@ public function getMigrations(Updater $updater)
     {
         return array(
             $this->migration->db->addColumn('site', 'creator_login', ' VARCHAR(100) NULL'),
+            $this->migration->plugin->activate('IntranetMeasurable'),
         );
     }
 
diff --git a/plugins/IntranetMeasurable/IntranetMeasurable.php b/plugins/IntranetMeasurable/IntranetMeasurable.php
new file mode 100644
index 00000000000..8b0aba0589a
--- /dev/null
+++ b/plugins/IntranetMeasurable/IntranetMeasurable.php
@@ -0,0 +1,46 @@
+<?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\IntranetMeasurable;
+
+use Piwik\Container\StaticContainer;
+use Piwik\Site;
+
+class IntranetMeasurable extends \Piwik\Plugin
+{
+    /**
+     * @see \Piwik\Plugin::registerEvents
+     */
+    public function registerEvents()
+    {
+        return array(
+            'Tracker.Cache.getSiteAttributes' => 'recordWebsiteDataInCache',
+        );
+    }
+
+    public function isTrackerPlugin()
+    {
+        return true;
+    }
+
+    public function recordWebsiteDataInCache(&$array, $idSite)
+    {
+        $idSite = (int) $idSite;
+        $type = Site::getTypeFor($idSite);
+        if ($type === Type::ID) {
+            /** @var \Piwik\Plugins\IntranetMeasurable\MeasurableSettings $measurableSettings */
+            $measurableSettings = StaticContainer::getContainer()->make(
+                '\Piwik\Plugins\IntranetMeasurable\MeasurableSettings',
+                array('idSite' => $idSite, 'idMeasurableType' => Site::getTypeFor($idSite))
+            );
+
+            // add the 'hosts' entry in the website array
+            $array['enable_trust_visitors_cookies'] = (int) $measurableSettings->trustvisitorcookies->getValue();
+        }
+    }
+}
diff --git a/plugins/IntranetMeasurable/MeasurableSettings.php b/plugins/IntranetMeasurable/MeasurableSettings.php
new file mode 100644
index 00000000000..e936c5f6a5f
--- /dev/null
+++ b/plugins/IntranetMeasurable/MeasurableSettings.php
@@ -0,0 +1,39 @@
+<?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\IntranetMeasurable;
+
+use Piwik\Piwik;
+use Piwik\Settings\FieldConfig;
+use Piwik\Settings\Setting;
+
+class MeasurableSettings extends \Piwik\Plugins\WebsiteMeasurable\MeasurableSettings
+{
+    /** @var Setting */
+    public $trustvisitorcookies;
+
+    protected function shouldShowSettingsForType($type)
+    {
+        return $type === Type::ID;
+    }
+
+    protected function init()
+    {
+        $this->trustvisitorcookies = $this->makeTrustVisitorCookies();
+        parent::init();
+    }
+
+    private function makeTrustVisitorCookies()
+    {
+        return $this->makeSetting('trust_visitors_cookies', $default = true, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
+            $field->title = Piwik::translate('IntranetMeasurable_TrustVisitorCookies');
+            $field->inlineHelp = Piwik::translate('IntranetMeasurable_TrustVisitorCookiesHelp');
+            $field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
+        });
+    }
+}
diff --git a/plugins/IntranetMeasurable/Tracker/RequestProcessor.php b/plugins/IntranetMeasurable/Tracker/RequestProcessor.php
new file mode 100644
index 00000000000..503aeeb0381
--- /dev/null
+++ b/plugins/IntranetMeasurable/Tracker/RequestProcessor.php
@@ -0,0 +1,37 @@
+<?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\IntranetMeasurable\Tracker;
+
+use Piwik\Container\StaticContainer;
+use Piwik\Plugins\IntranetMeasurable\MeasurableSettings;
+use Piwik\Plugins\IntranetMeasurable\Type;
+use Piwik\Tracker\Cache;
+use Piwik\Tracker\Request;
+
+class RequestProcessor extends \Piwik\Tracker\RequestProcessor
+{
+    private $settingName = 'ini.Tracker.trust_visitors_cookies';
+
+    public function manipulateRequest(Request $request)
+    {
+        $idSite = $request->getIdSite();
+        if ($idSite && !StaticContainer::get($this->settingName)) {
+            // we may need to enable it for an intranet site...
+
+            $site = Cache::getCacheWebsiteAttributes($idSite);
+            if (!empty($site['type'])
+                && $site['type'] === Type::ID
+                && !empty($site['enable_trust_visitors_cookies'])) {
+
+                StaticContainer::get('Piwik\Tracker\VisitorRecognizer')->setTrustCookiesOnly(1);
+                StaticContainer::getContainer()->set($this->settingName, 1);
+            }
+        }
+    }
+}
diff --git a/plugins/IntranetMeasurable/Type.php b/plugins/IntranetMeasurable/Type.php
new file mode 100644
index 00000000000..a6636e2771c
--- /dev/null
+++ b/plugins/IntranetMeasurable/Type.php
@@ -0,0 +1,20 @@
+<?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\IntranetMeasurable;
+
+class Type extends \Piwik\Measurable\Type
+{
+    const ID = 'intranet';
+    protected $name = 'IntranetMeasurable_Intranet';
+    protected $namePlural = 'IntranetMeasurable_Intranets';
+    protected $description = 'IntranetMeasurable_IntranetDescription';
+    protected $howToSetupUrl = '?module=CoreAdminHome&action=trackingCodeGenerator';
+
+}
+
diff --git a/plugins/IntranetMeasurable/lang/en.json b/plugins/IntranetMeasurable/lang/en.json
new file mode 100644
index 00000000000..091f8aeec8d
--- /dev/null
+++ b/plugins/IntranetMeasurable/lang/en.json
@@ -0,0 +1,9 @@
+{
+    "IntranetMeasurable": {
+        "Intranet": "Intranet",
+        "Intranets": "Intranets",
+        "IntranetDescription": "An intranet measurable is just like a website but hosted on an internal network.",
+        "TrustVisitorCookies": "Trust Visitor Cookies",
+        "TrustVisitorCookiesHelp": "This should be enabled when most visitors have the same configuration (browsers, operating systems); and the same IP for better unique visitors recognition. If disabled, all visitors will be counted as one single visitor."
+    }
+}
\ No newline at end of file
diff --git a/plugins/IntranetMeasurable/plugin.json b/plugins/IntranetMeasurable/plugin.json
new file mode 100644
index 00000000000..c3a1800532c
--- /dev/null
+++ b/plugins/IntranetMeasurable/plugin.json
@@ -0,0 +1,4 @@
+{
+  "name": "IntranetMeasurable",
+  "description": "Analytics for the web: lets you measure and analyze intranet websites."
+}
\ No newline at end of file
diff --git a/plugins/SitesManager/SitesManager.php b/plugins/SitesManager/SitesManager.php
index 15c1129d03a..c1c4e1dc209 100644
--- a/plugins/SitesManager/SitesManager.php
+++ b/plugins/SitesManager/SitesManager.php
@@ -159,6 +159,7 @@ public function recordWebsiteDataInCache(&$array, $idSite)
         $array['sitesearch_category_parameters'] = $this->getTrackerSearchCategoryParameters($website);
         $array['timezone'] = $this->getTimezoneFromWebsite($website);
         $array['ts_created'] = $website['ts_created'];
+        $array['type'] = $website['type'];
     }
 
     /**