Allow customization of GeoIP2 database location using DI (matomo-org#…

…13913)
fdellwing · Mar 15, 2019 · 3474bf2 · 3474bf2
1 parent a99baa9
commit 3474bf2
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 21 deletions.
diff --git a/plugins/GeoIp2/LocationProvider/GeoIp2.php b/plugins/GeoIp2/LocationProvider/GeoIp2.php
@@ -9,6 +9,7 @@
 namespace Piwik\Plugins\GeoIp2\LocationProvider;
 
 use Exception;
+use Piwik\Container\StaticContainer;
 use Piwik\Option;
 use Piwik\Piwik;
 use Piwik\Plugins\UserCountry\LocationProvider;
@@ -23,8 +24,6 @@ abstract class GeoIp2 extends LocationProvider
     const TEST_IP = '194.57.91.215';
     const SWITCH_TO_ISO_REGIONS_OPTION_NAME = 'usercountry.switchtoisoregions';
 
-    public static $geoIPDatabaseDir = 'misc';
-
     /**
      * Cached region name array. Data is from geoipregionvars.php.
      *
@@ -125,7 +124,7 @@ public static function getPathToGeoIpDatabase($possibleFileNames)
      */
     public static function getPathForGeoIpDatabase($filename)
     {
-        return PIWIK_INCLUDE_PATH . '/' . self::$geoIPDatabaseDir . '/' . $filename;
+        return StaticContainer::get('path.geoip2') . $filename;
     }
 
     /**

diff --git a/plugins/GeoIp2/config/config.php b/plugins/GeoIp2/config/config.php
@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'path.geoip2' => DI\string('{path.root}/misc/'),
+];
diff --git a/plugins/GeoIp2/config/test.php b/plugins/GeoIp2/config/test.php
@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'path.geoip2' => DI\string('{path.root}/tests/lib/geoip-files/'),
+];
diff --git a/plugins/GeoIp2/tests/Integration/LocationProviderTest.php b/plugins/GeoIp2/tests/Integration/LocationProviderTest.php
@@ -17,8 +17,6 @@ class LocationProviderTest extends \PHPUnit_Framework_TestCase
 {
     public function testGeoIP2City()
     {
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
-
         $locationProvider = new GeoIp2\Php(['loc' => ['GeoIP2-City.mmdb'], 'isp' => []]);
         $result = $locationProvider->getLocation(['ip' => '194.57.91.215']);
 
@@ -38,8 +36,6 @@ public function testGeoIP2City()
 
     public function testGeoIP2Country()
     {
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
-
         $locationProvider = new GeoIp2\Php(['loc' => ['GeoIP2-Country.mmdb'], 'isp' => []]);
         $result = $locationProvider->getLocation(['ip' => '194.57.91.215']);
 
@@ -53,8 +49,6 @@ public function testGeoIP2Country()
 
     public function testGeoIP2ASN()
     {
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
-
         $locationProvider = new GeoIp2\Php(['loc' => [], 'isp' => ['GeoLite2-ASN.mmdb']]);
         $result = $locationProvider->getLocation(['ip' => '194.57.91.215']);
 
@@ -66,8 +60,6 @@ public function testGeoIP2ASN()
 
     public function testGeoIP2ISP()
     {
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
-
         $locationProvider = new GeoIp2\Php(['loc' => [], 'isp' => ['GeoIP2-ISP.mmdb']]);
         $result = $locationProvider->getLocation(['ip' => '194.57.91.215']);
 
@@ -79,8 +71,6 @@ public function testGeoIP2ISP()
 
     public function testGeoIP2CityAndISP()
     {
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
-
         $locationProvider = new GeoIp2\Php(['loc' => ['GeoIP2-City.mmdb'], 'isp' => ['GeoIP2-ISP.mmdb']]);
         $result = $locationProvider->getLocation(['ip' => '194.57.91.215']);
 

diff --git a/plugins/GeoIp2/tests/System/ConvertRegionCodesToIsoTest.php b/plugins/GeoIp2/tests/System/ConvertRegionCodesToIsoTest.php
@@ -38,7 +38,6 @@ public function setUp()
         self::$idSite = Fixture::createWebsite('2016-01-01');
         Fixture::createSuperUser(true);
 
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
         LocationProvider::$providers = null;
         LocationProvider::setCurrentProvider('geoip2php');
     }

diff --git a/plugins/UserCountry/tests/Integration/APITest.php b/plugins/UserCountry/tests/Integration/APITest.php
@@ -42,7 +42,6 @@ public function setUp()
 
     public function test_setLocationProvider()
     {
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
         $locationProvider = GeoIp2\Php::ID;
         $this->api->setLocationProvider($locationProvider);
         $this->assertEquals($locationProvider, Common::getCurrentLocationProviderId());

diff --git a/tests/PHPUnit/Fixtures/ManySitesImportedLogs.php b/tests/PHPUnit/Fixtures/ManySitesImportedLogs.php
@@ -37,7 +37,6 @@ public function setUp()
         $this->setUpWebsitesAndGoals();
 
         LocationProvider::$providers = null;
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
         LocationProvider::setCurrentProvider('geoip2php');
 
         self::createSuperUser();
@@ -49,7 +48,6 @@ public function setUp()
     public function tearDown()
     {
         LocationProvider::$providers = null;
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
         ManyVisitsWithGeoIP::unsetLocationProvider();
     }
 

diff --git a/tests/PHPUnit/Fixtures/ManyVisitsWithGeoIP.php b/tests/PHPUnit/Fixtures/ManyVisitsWithGeoIP.php
@@ -245,7 +245,6 @@ private function trackOtherVisits()
     public function setLocationProvider($file)
     {
         GeoIp2::$dbNames['loc'] = array($file);
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
         LocationProvider::$providers = null;
         LocationProvider::setCurrentProvider(self::GEOIP_IMPL_TO_TEST);
 

diff --git a/tests/PHPUnit/Fixtures/UITestFixture.php b/tests/PHPUnit/Fixtures/UITestFixture.php
@@ -79,7 +79,6 @@ public function setUp()
         );
 
         // for proper geolocation
-        GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
         LocationProvider::setCurrentProvider(GeoIp2\Php::ID);
         IPAnonymizer::deactivate();
 

diff --git a/tests/PHPUnit/proxy/piwik.php b/tests/PHPUnit/proxy/piwik.php
@@ -33,8 +33,6 @@
 
     Environment::setGlobalEnvironmentManipulator(new TestingEnvironmentManipulator(new TestingEnvironmentVariables(), $globalObservers));
 
-    \Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2::$geoIPDatabaseDir = 'tests/lib/geoip-files';
-
     include PIWIK_INCLUDE_PATH . '/matomo.php';
 } catch (Exception $ex) {
     echo "Unexpected error during tracking: " . $ex->getMessage() . "\n" . $ex->getTraceAsString() . "\n";