diff --git a/module/VuFind/src/VuFind/Net/UserIpReaderFactory.php b/module/VuFind/src/VuFind/Net/UserIpReaderFactory.php
index b6cd03b7fd621f3f6db7739433b590fa9bfab57a..46725593ede80edb866b6086aea9391ea6a77ab9 100644
--- a/module/VuFind/src/VuFind/Net/UserIpReaderFactory.php
+++ b/module/VuFind/src/VuFind/Net/UserIpReaderFactory.php
@@ -65,11 +65,11 @@ class UserIpReaderFactory implements \Laminas\ServiceManager\Factory\FactoryInte
$config = $container->get(\VuFind\Config\PluginManager::class)
->get('config');
$allowForwardedIps = $config->Proxy->allow_forwarded_ips ?? false;
- $ipFilter = (array)($config->Proxy->forwarded_ip_filter ?? []);
+ $ipFilter = $config->Proxy->forwarded_ip_filter ?? [];
return new $requestedName(
$container->get('Request')->getServer(),
$allowForwardedIps,
- $ipFilter
+ is_object($ipFilter) ? $ipFilter->toArray() : (array)$ipFilter
);
}
}
diff --git a/module/VuFind/tests/unit-tests/src/VuFindTest/Net/UserIpReaderFactoryTest.php b/module/VuFind/tests/unit-tests/src/VuFindTest/Net/UserIpReaderFactoryTest.php
new file mode 100644
index 0000000000000000000000000000000000000000..ef2f7955595bf0a1e0926504652403168d0393fb
--- /dev/null
+++ b/module/VuFind/tests/unit-tests/src/VuFindTest/Net/UserIpReaderFactoryTest.php
@@ -0,0 +1,160 @@
+<?php
+/**
+ * UserIpReaderFactory Test Class
+ *
+ * PHP version 7
+ *
+ * Copyright (C) Villanova University 2020.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * @category VuFind
+ * @package Tests
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:testing:unit_tests Wiki
+ */
+namespace VuFindTest\Net;
+
+use Laminas\Config\Config;
+use Laminas\Stdlib\Parameters;
+use VuFind\Net\UserIpReaderFactory;
+
+/**
+ * UserIpReaderFactory Test Class
+ *
+ * @category VuFind
+ * @package Tests
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:testing:unit_tests Wiki
+ */
+class UserIpReaderFactoryTest extends \VuFindTest\Unit\MockContainerTest
+{
+ /**
+ * Get a container set up for the factory.
+ *
+ * @param array $config Configuration (simulated config.ini)
+ * @param array $server Simulated $_SERVER superglobal data
+ *
+ * @return \Interop\Container\ContainerInterface
+ */
+ protected function getContainer($config = [], $server = ['server' => true])
+ {
+ $configManager = $this->getMockBuilder(\VuFind\Config\PluginManager::class)
+ ->disableOriginalConstructor()->getMock();
+ $configManager->expects($this->once())->method('get')
+ ->with($this->equalTo('config'))
+ ->will($this->returnValue(new Config($config)));
+ $this->container->set(\VuFind\Config\PluginManager::class, $configManager);
+ $mockRequest = $this
+ ->getMockBuilder(\Laminas\Http\PhpEnvironment\Request::class)
+ ->disableOriginalConstructor()->getMock();
+ $mockRequest->expects($this->once())->method('getServer')
+ ->will($this->returnValue(new Parameters($server)));
+ $this->container->set('Request', $mockRequest);
+ return $this->container;
+ }
+
+ /**
+ * Test the factory's defaults
+ *
+ * @return void
+ */
+ public function testDefaults()
+ {
+ $factory = new UserIpReaderFactory();
+ $container = $this->getContainer();
+ $reader = $factory($container, UserIpReader::class);
+ list($server, $allowForwardedIps, $ipFilter) = $reader->args;
+ $this->assertEquals(['server' => true], $server->toArray());
+ $this->assertFalse($allowForwardedIps);
+ $this->assertEquals([], $ipFilter);
+ }
+
+ /**
+ * Test non-default values, with a single filtered IP
+ *
+ * @return void
+ */
+ public function testNonDefaultsWithSingleFilteredIP()
+ {
+ $factory = new UserIpReaderFactory();
+ $container = $this->getContainer(
+ [
+ 'Proxy' => [
+ 'allow_forwarded_ips' => true,
+ 'forwarded_ip_filter' => '1.2.3.4',
+ ]
+ ]
+ );
+ $reader = $factory($container, UserIpReader::class);
+ list($server, $allowForwardedIps, $ipFilter) = $reader->args;
+ $this->assertEquals(['server' => true], $server->toArray());
+ $this->assertTrue($allowForwardedIps);
+ $this->assertEquals(['1.2.3.4'], $ipFilter);
+ }
+
+ /**
+ * Test non-default values, with multiple filtered IPs
+ *
+ * @return void
+ */
+ public function testNonDefaultsWithMultipleFilteredIPs()
+ {
+ $factory = new UserIpReaderFactory();
+ $container = $this->getContainer(
+ [
+ 'Proxy' => [
+ 'allow_forwarded_ips' => true,
+ 'forwarded_ip_filter' => ['1.2.3.4', '5.6.7.8'],
+ ]
+ ]
+ );
+ $reader = $factory($container, UserIpReader::class);
+ list($server, $allowForwardedIps, $ipFilter) = $reader->args;
+ $this->assertEquals(['server' => true], $server->toArray());
+ $this->assertTrue($allowForwardedIps);
+ $this->assertEquals(['1.2.3.4', '5.6.7.8'], $ipFilter);
+ }
+}
+
+/**
+ * Test harness for capturing constructor parameters.
+ *
+ * @category VuFind
+ * @package Tests
+ * @author Demian Katz <demian.katz@villanova.edu>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:testing:unit_tests Wiki
+ */
+class UserIpReader extends \VuFind\Net\UserIpReader
+{
+ /**
+ * Property for storing constructor arguments for testing.
+ *
+ * @var array
+ */
+ public $args;
+
+ /**
+ * Constructor
+ */
+ public function __construct()
+ {
+ $args = func_get_args();
+ $this->args = $args;
+ parent::__construct(...$args);
+ }
+}