Adding new setting allowing to disable Geolocation tab for super users

matomo-org · Jan 7, 2014 · 7cf62c4 · 7cf62c4
1 parent 70f689a
commit 7cf62c4
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/config/global.ini.php b/config/global.ini.php
@@ -352,6 +352,9 @@
 ; the access to disk and install custom PHP code (Piwik plugins).
 enable_marketplace = 1
 
+; By setting this option to 0, you can prevent Super User from editing the Geolocation settings.
+enable_geolocation_admin = 1
+
 ; If php is running in a chroot environment, when trying to import CSV files with createTableFromCSVFile(),
 ; Mysql will try to load the chrooted path (which is imcomplete). To prevent an error, here you can specify the
 ; absolute path to the chroot environment. eg. '/path/to/piwik/chrooted/'

diff --git a/plugins/UserCountry/Controller.php b/plugins/UserCountry/Controller.php
@@ -47,11 +47,11 @@ public function index()
 
     public function adminIndex()
     {
+        $this->dieIfGeolocationAdminIsDisabled();
         Piwik::checkUserIsSuperUser();
         $view = new View('@UserCountry/adminIndex');
 
-        $allProviderInfo = LocationProvider::getAllProviderInfo(
-            $newline = '<br/>', $includeExtra = true);
+        $allProviderInfo = LocationProvider::getAllProviderInfo($newline = '<br/>', $includeExtra = true);
         $view->locationProviders = $allProviderInfo;
         $view->currentProviderId = LocationProvider::getCurrentProviderId();
         $view->thisIP = IP::getIpFromHeader();
@@ -108,6 +108,7 @@ public function adminIndex()
      */
     public function downloadFreeGeoIPDB()
     {
+        $this->dieIfGeolocationAdminIsDisabled();
         Piwik::checkUserIsSuperUser();
         if ($_SERVER["REQUEST_METHOD"] == "POST") {
             $this->checkTokenInUrl();
@@ -191,6 +192,7 @@ private function setUpdaterManageVars($view)
      */
     public function updateGeoIPLinks()
     {
+        $this->dieIfGeolocationAdminIsDisabled();
         Piwik::checkUserIsSuperUser();
         if ($_SERVER["REQUEST_METHOD"] == "POST") {
             Json::sendHeaderJSON();
@@ -232,6 +234,7 @@ public function updateGeoIPLinks()
      */
     public function downloadMissingGeoIpDb()
     {
+        $this->dieIfGeolocationAdminIsDisabled();
         Piwik::checkUserIsSuperUser();
         if ($_SERVER["REQUEST_METHOD"] == "POST") {
             try {
@@ -284,6 +287,7 @@ public function downloadMissingGeoIpDb()
      */
     public function setCurrentLocationProvider()
     {
+        $this->dieIfGeolocationAdminIsDisabled();
         Piwik::checkUserIsSuperUser();
         if ($_SERVER["REQUEST_METHOD"] == "POST") {
             $this->checkTokenInUrl();
@@ -387,4 +391,11 @@ private function getNextMissingDbUrlInfo()
         }
         return false;
     }
+
+    private function dieIfGeolocationAdminIsDisabled()
+    {
+        if(!UserCountry::isGeoLocationAdminEnabled()) {
+            throw new \Exception('Geo location setting page has been disabled.');
+        }
+    }
 }
diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php
@@ -195,10 +195,12 @@ public function addMenu()
      */
     public function addAdminMenu()
     {
-        MenuAdmin::getInstance()->add('General_Settings', 'UserCountry_Geolocation',
-            array('module' => 'UserCountry', 'action' => 'adminIndex'),
-            Piwik::isUserIsSuperUser(),
-            $order = 8);
+        if($this->isGeoLocationAdminEnabled()) {
+            MenuAdmin::getInstance()->add('General_Settings', 'UserCountry_Geolocation',
+                array('module' => 'UserCountry', 'action' => 'adminIndex'),
+                Piwik::isUserIsSuperUser(),
+                $order = 8);
+        }
     }
 
     public function getSegmentsMetadata(&$segments)
@@ -480,4 +482,10 @@ public function getClientSideTranslationKeys(&$translationKeys)
         $translationKeys[] = "UserCountry_SetupAutomaticUpdatesOfGeoIP";
         $translationKeys[] = "General_Done";
     }
+
+    public static function isGeoLocationAdminEnabled()
+    {
+        return (bool) Config::getInstance()->General['enable_geolocation_admin'];
+    }
+
 }