Merge pull request #7365 from piwik/no-data-welcome

Show the JS tracking code instead of the dashboard while no visit is tracked

core/Tracker/Model.php

@@ -391,6 +391,21 @@ public function findVisitor($idSite, $configId, $idVisitor, $fieldsToRead, $numC
         return $visitRow;
     }
 
+    /**
+     * Returns true if the site doesn't have log data.
+     *
+     * @param int $siteId
+     * @return bool
+     */
+    public function isSiteEmpty($siteId)
+    {
+        $sql = sprintf('SELECT idsite FROM %s WHERE idsite = ? limit 1', Common::prefixTable('log_visit'));
+
+        $result = \Piwik\Db::fetchOne($sql, array($siteId));
+
+        return $result == null;
+    }
+
     private function visitFieldsToQuery($valuesToUpdate)
     {
         $updateParts = array();

plugins/SitesManager/Controller.php

@@ -15,6 +15,7 @@
 use Piwik\SettingsPiwik;
 use Piwik\Site;
 use Piwik\Tracker\TrackerCodeGenerator;
+use Piwik\Url;
 use Piwik\View;
 
 /**
@@ -118,4 +119,20 @@ function downloadPiwikTracker()
         header('Content-Disposition: attachment; filename="' . $filename . '"');
         return file_get_contents($path . $filename);
     }
+
+    public function siteWithoutData()
+    {
+        $javascriptGenerator = new TrackerCodeGenerator();
+        $piwikUrl = Url::getCurrentUrlWithoutFileName();
+
+        return $this->renderTemplate('siteWithoutData', array(
+            'siteName'     => $this->site->getName(),
+            'trackingHelp' => $this->renderTemplate('_displayJavascriptCode', array(
+                'displaySiteName' => $this->site->getName(),
+                'jsTag'           => $javascriptGenerator->generate($this->idSite, $piwikUrl),
+                'idSite'          => $this->idSite,
+                'piwikUrl'        => $piwikUrl,
+            )),
+        ));
+    }
 }

plugins/SitesManager/SitesManager.php

@@ -7,8 +7,12 @@
  *
  */
 namespace Piwik\Plugins\SitesManager;
+
+use Piwik\Common;
 use Piwik\DataAccess\ArchiveInvalidator;
+use Piwik\Db;
 use Piwik\Tracker\Cache;
+use Piwik\Tracker\Model as TrackerModel;
 
 /**
  *
@@ -29,10 +33,29 @@ public function getListHooksRegistered()
             'AssetManager.getStylesheetFiles'        => 'getStylesheetFiles',
             'Tracker.Cache.getSiteAttributes'        => 'recordWebsiteDataInCache',
             'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
-            'SitesManager.deleteSite.end'            => 'onSiteDeleted'
+            'SitesManager.deleteSite.end'            => 'onSiteDeleted',
+            'Request.dispatch'                       => 'redirectDashboardToWelcomePage',
         );
     }
 
+    public function redirectDashboardToWelcomePage(&$module, &$action)
+    {
+        if ($module !== 'CoreHome' || $action !== 'index') {
+            return;
+        }
+
+        $siteId = Common::getRequestVar('idSite', false, 'int');
+        if (!$siteId) {
+            return;
+        }
+
+        $trackerModel = new TrackerModel();
+        if ($trackerModel->isSiteEmpty($siteId)) {
+            $module = 'SitesManager';
+            $action = 'siteWithoutData';
+        }
+    }
+
     public function onSiteDeleted($idSite)
     {
         // we do not delete logs here on purpose (you can run these queries on the log_ tables to delete all data)

plugins/SitesManager/lang/en.json

@@ -64,6 +64,9 @@
         "ShowTrackingTag": "View Tracking code",
         "Sites": "Websites",
         "SiteSearchUse": "You can use Piwik to track and report what visitors are searching in your website's internal search engine.",
+        "SiteWithoutDataTitle": "No data has been recorded yet",
+        "SiteWithoutDataDescription": "No analytics data has been tracked for this website yet.",
+        "SiteWithoutDataSetupTracking": "Please set up the %1$sJavaScript tracking code%2$s on your website and refresh the page.",
         "SuperUserAccessCan": "A user with Super User access can also %s specify global settings%s for new websites.",
         "Timezone": "Time zone",
         "TrackingSiteSearch": "Tracking Internal Site Search",

plugins/SitesManager/stylesheets/SitesManager.less

@@ -35,4 +35,21 @@ td.editable-site-field:hover {
 
 .link_but:hover > span {
   text-decoration: underline;
-}
+}
+
+.site-without-data {
+  padding: 15px;
+  h2 {
+    border-bottom: 1px solid #ccc;
+    margin: 25px 0;
+    padding: 0 0 5px 0;
+    font-size: 24px;
+  }
+  h3 {
+    margin: 15px 0;
+    font-size: 18px;
+    line-height: 24px;
+    font-weight: normal;
+    color: black;
+  }
+}

plugins/SitesManager/templates/siteWithoutData.twig

@@ -0,0 +1,25 @@
+{% extends "dashboard.twig" %}
+
+{% block notification %}{% endblock %}
+
+{% block content %}
+
+    {% include "@CoreHome/_siteSelectHeader.twig" %}
+
+    <div class="site-without-data">
+
+        <h2>{{ 'SitesManager_SiteWithoutDataTitle'|translate }}</h2>
+
+        <p>
+            {{ 'SitesManager_SiteWithoutDataDescription'|translate }}
+            {{ 'SitesManager_SiteWithoutDataSetupTracking'|translate('<a href="' ~ linkTo({
+                'module': 'CoreAdminHome',
+                'action': 'trackingCodeGenerator',
+            }) ~ '">', '</a>')|raw }}
+        </p>
+
+        {{ trackingHelp|raw }}
+
+    </div>
+
+{% endblock %}

plugins/SitesManager/tests/UI/.gitignore

@@ -0,0 +1,2 @@
+/processed-ui-screenshots
+/screenshot-diffs

plugins/SitesManager/tests/UI/EmptySite_spec.js

@@ -0,0 +1,22 @@
+/*!
+ * Piwik - free/libre analytics platform
+ *
+ * Screenshot integration tests.
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+describe("EmptySite", function () {
+    this.timeout(0);
+
+    var generalParams = 'idSite=4&period=day&date=2010-01-03';
+
+    it('should show the tracking code if the website has no recorded data', function (done) {
+        var urlToTest = "?" + generalParams + "&module=CoreHome&action=index";
+
+        expect.screenshot('emptySiteDashboard').to.be.captureSelector('.site-without-data', function (page) {
+            page.load(urlToTest);
+        }, done);
+    });
+});

tests/PHPUnit/Integration/Tracker/ModelTest.php

@@ -9,6 +9,7 @@
 
 use Piwik\Common;
 use Piwik\Db;
+use Piwik\Tests\Fixtures\OneVisitorTwoVisits;
 use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
 use Piwik\Tracker\Model;
 
@@ -111,6 +112,16 @@ public function test_getIdsAction_CorrectlyReturnsLowestIdActions_IfDuplicateIdA
         $this->assertEquals($expectedResult, $result);
     }
 
+    public function test_isSiteEmpty()
+    {
+        $this->assertTrue($this->model->isSiteEmpty(1));
+
+        $fixture = new OneVisitorTwoVisits();
+        $fixture->setUp();
+
+        $this->assertFalse($this->model->isSiteEmpty(1));
+    }
+
     private function assertLogActionTableContainsTestAction($idaction)
     {
         $expectedRows = array(