Remember user who created a site. (matomo-org#13362)

* Remember user who created a site. * Bump version & change column name to creator_login. * Rename Site::getCreationUserFor * Process sites like other methods in getPatternMatchSites(). * Update expected test files. * update test again
InfinityVoid · Oct 11, 2018 · 2d1facb · 2d1facb
1 parent e2bedb0
commit 2d1facb
Show file tree

Hide file tree

Showing 9 changed files with 109 additions and 1 deletion.
diff --git a/core/Db/Schema/Mysql.php b/core/Db/Schema/Mysql.php
@@ -75,6 +75,7 @@ public function getTablesCreateSql()
                             `group` VARCHAR(250) NOT NULL,
                             `type` VARCHAR(255) NOT NULL,
                             keep_url_fragment TINYINT NOT NULL DEFAULT 0,
+                            creator_login VARCHAR(100) NULL,
                               PRIMARY KEY(idsite)
                             ) ENGINE=$engine DEFAULT CHARSET=utf8
             ",

diff --git a/core/Site.php b/core/Site.php
@@ -646,4 +646,15 @@ public static function getExcludedQueryParametersFor($idsite)
     {
         return self::getFor($idsite, 'excluded_parameters');
     }
+
+    /**
+     * Returns the user that created this site.
+     *
+     * @param int $idsite The site ID.
+     * @return string|null If null, the site was created before the creation user was tracked.
+     */
+    public static function getCreatorLoginFor($idsite)
+    {
+        return self::getFor($idsite, 'creator_login');
+    }
 }
diff --git a/core/Updates/3.6.1-b2.php b/core/Updates/3.6.1-b2.php
@@ -0,0 +1,43 @@
+<?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\Updates;
+
+use Piwik\Common;
+use Piwik\Updater\Migration\Factory as MigrationFactory;
+use Piwik\Updates;
+use Piwik\Updater;
+
+/**
+ * Update for version 3.6.1-b2.
+ */
+class Updates_3_6_1_b2 extends Updates
+{
+    /**
+     * @var MigrationFactory
+     */
+    private $migration;
+
+    public function __construct(MigrationFactory $factory)
+    {
+        $this->migration = $factory;
+    }
+
+    public function getMigrations(Updater $updater)
+    {
+        return array(
+            $this->migration->db->addColumn('site', 'creator_login', ' VARCHAR(100) NULL'),
+        );
+    }
+
+    public function doUpdate(Updater $updater)
+    {
+        $updater->executeMigrations(__FILE__, $this->getMigrations($updater));
+    }
+}
diff --git a/core/Version.php b/core/Version.php
@@ -20,7 +20,7 @@ final class Version
      * The current Matomo version.
      * @var string
      */
-    const VERSION = '3.6.1-b1';
+    const VERSION = '3.6.1-b2';
 
     public function isStableVersion($version)
     {

diff --git a/...ferrers/tests/System/expected/test_phpSerialized__Referrers.getReferrerType_year.original b/...ferrers/tests/System/expected/test_phpSerialized__Referrers.getReferrerType_year.original
diff --git a/plugins/SitesManager/API.php b/plugins/SitesManager/API.php
@@ -547,6 +547,11 @@ private function enrichSite(&$site)
         $name = Piwik::translate($key);
 
         $site['currency_name'] = ($key === $name) ? $site['currency'] : $name;
+
+        // don't want to expose other user logins here
+        if (!Piwik::hasUserSuperUserAccess()) {
+            unset($site['creator_login']);
+        }
     }
 
     /**
@@ -648,6 +653,8 @@ public function addSite($siteName,
             $bind['group'] = "";
         }
 
+        $bind['creator_login'] = Piwik::getCurrentUserLogin();
+
         $allSettings = $this->setAndValidateMeasurableSettings(0, 'website', $coreProperties);
 
         // any setting specified in setting values will overwrite other setting
@@ -1622,7 +1629,12 @@ public function getPatternMatchSites($pattern, $limit = false)
 
         $sites = $this->getModel()->getPatternMatchSites($ids, $pattern, $limit);
 
+        foreach ($sites as &$site) {
+            $this->enrichSite($site);
+        }
+
         $sites = Site::setSitesFromArray($sites);
+
         return $sites;
     }
 

diff --git a/plugins/SitesManager/tests/Integration/ApiTest.php b/plugins/SitesManager/tests/Integration/ApiTest.php
@@ -124,6 +124,8 @@ private function addSiteTest($expectedWebsiteType, $settingValues = null)
         $this->assertTrue(Site::isSiteSearchEnabledFor($idsite));
         $this->assertEquals($expectedWebsiteType, $siteInfo['type']);
         $this->assertEquals($expectedWebsiteType, Site::getTypeFor($idsite));
+        $this->assertEquals('superUserLogin', $siteInfo['creator_login']);
+        $this->assertEquals('superUserLogin', Site::getCreatorLoginFor($idsite));
 
         $this->assertEquals($searchKeywordParameters, $siteInfo['sitesearch_keyword_parameters']);
         $this->assertEquals($searchCategoryParameters, $siteInfo['sitesearch_category_parameters']);

diff --git a/...tesManager/tests/System/expected/test_SitesManager__SitesManager.getPatternMatchSites.xml b/...tesManager/tests/System/expected/test_SitesManager__SitesManager.getPatternMatchSites.xml
@@ -18,6 +18,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>10</idsite>
@@ -37,6 +40,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>11</idsite>
@@ -56,6 +62,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>12</idsite>
@@ -75,6 +84,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>13</idsite>
@@ -94,6 +106,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>14</idsite>
@@ -113,6 +128,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>15</idsite>
@@ -132,6 +150,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>16</idsite>
@@ -151,6 +172,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>17</idsite>
@@ -170,6 +194,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>18</idsite>
@@ -189,6 +216,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>19</idsite>
@@ -208,5 +238,8 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 </result>
diff --git a/...r/tests/System/expected/test_SitesManagerwithLimit__SitesManager.getPatternMatchSites.xml b/...r/tests/System/expected/test_SitesManagerwithLimit__SitesManager.getPatternMatchSites.xml
@@ -18,6 +18,9 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 	<row>
 		<idsite>10</idsite>
@@ -37,5 +40,8 @@
 		<group />
 		<type>website</type>
 		<keep_url_fragment>0</keep_url_fragment>
+		<creator_login>superUserLogin</creator_login>
+		<timezone_name>UTC</timezone_name>
+		<currency_name>US Dollar</currency_name>
 	</row>
 </result>