MAG2-59 - Added proxy mode to TransactionStatus script

Fixes PAYONE-GmbH#143

Author: FatchipRobert

Helper/Environment.php

@@ -31,6 +31,31 @@
  */
 class Environment extends \Payone\Core\Helper\Base
 {
+    /**
+     * Extended remote address object
+     *
+     * @var \Payone\Core\Model\Environment\RemoteAddress
+     */
+    protected $remoteAddress;
+
+    /**
+     * Constructor
+     *
+     * @param \Magento\Framework\App\Helper\Context        $context
+     * @param \Magento\Store\Model\StoreManagerInterface   $storeManager
+     * @param \Payone\Core\Helper\Shop                     $shopHelper
+     * @param \Payone\Core\Model\Environment\RemoteAddress $remoteAddress
+     */
+    public function __construct(
+        \Magento\Framework\App\Helper\Context $context,
+        \Magento\Store\Model\StoreManagerInterface $storeManager,
+        \Payone\Core\Helper\Shop $shopHelper,
+        \Payone\Core\Model\Environment\RemoteAddress $remoteAddress
+    ) {
+        parent::__construct($context, $storeManager, $shopHelper);
+        $this->remoteAddress = $remoteAddress;
+    }
+
     /**
      * Get encoding
      *
@@ -44,11 +69,16 @@ public function getEncoding()
     /**
      * Get the IP of the requesting client
      *
+     * @param  bool $blUseHttpXForwarded
      * @return string
      */
-    public function getRemoteIp()
+    public function getRemoteIp($blUseHttpXForwarded = false)
     {
-        return $this->_remoteAddress->getRemoteAddress();
+        $blProxyMode = (bool)$this->getConfigParam('proxy_mode', 'processing', 'payone_misc');
+        if ($blUseHttpXForwarded === true && $blProxyMode === true) {
+            $this->remoteAddress->useHttpXForwarded();
+        }
+        return $this->remoteAddress->getRemoteAddress();
     }
 
     /**
@@ -58,7 +88,7 @@ public function getRemoteIp()
      */
     public function isRemoteIpValid()
     {
-        $sRemoteIp = $this->getRemoteIp();
+        $sRemoteIp = $this->getRemoteIp(true);
         $sValidIps = $this->getConfigParam('valid_ips', 'processing', 'payone_misc');
         $aWhitelist = explode("\n", $sValidIps);
         $aWhitelist = array_filter(array_map('trim', $aWhitelist));

Model/Environment/RemoteAddress.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * PAYONE Magento 2 Connector 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * PHP version 5
+ *
+ * @category  Payone
+ * @package   Payone_Magento2_Plugin
+ * @author    FATCHIP GmbH <[email protected]>
+ * @copyright 2003 - 2016 Payone GmbH
+ * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
+ * @link      http://www.payone.de
+ */
+
+namespace Payone\Core\Model\Environment;
+
+use Magento\Framework\HTTP\PhpEnvironment\RemoteAddress as CoreRemoteAddress;
+
+/**
+ * Extended RemoteAddress class
+ */
+class RemoteAddress extends CoreRemoteAddress
+{
+    /**
+     * Add X-Forwarded-For header to IP address determination
+     *
+     * @return void
+     */
+    public function useHttpXForwarded()
+    {
+        if (array_key_exists('x-forwarded-for', $this->alternativeHeaders) === false) {
+            $this->alternativeHeaders['x-forwarded-for'] = 'HTTP_X_FORWARDED_FOR';
+        }
+    }
+}

Test/Unit/Helper/EnvironmentTest.php

@@ -33,7 +33,7 @@
 use Magento\Framework\App\Helper\Context;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Framework\App\Config\ScopeConfigInterface;
-use Magento\Framework\HTTP\PhpEnvironment\RemoteAddress;
+use Payone\Core\Model\Environment\RemoteAddress;
 use Payone\Core\Test\Unit\BaseTestCase;
 use Payone\Core\Test\Unit\PayoneObjectManager;
 
@@ -72,7 +72,8 @@ protected function setUp()
 
         $this->environment = $this->objectManager->getObject(Environment::class, [
             'context' => $context,
-            'storeManager' => $storeManager
+            'storeManager' => $storeManager,
+            'remoteAddress' => $remoteAddress
         ]);
     }
 
@@ -99,7 +100,8 @@ public function testIsRemoteIpValid()
             ->method('getValue')
             ->willReturnMap(
                 [
-                    ['payone_misc/processing/valid_ips', ScopeInterface::SCOPE_STORE, null, $sWhitelist]
+                    ['payone_misc/processing/valid_ips', ScopeInterface::SCOPE_STORE, null, $sWhitelist],
+                    ['payone_misc/processing/proxy_mode', ScopeInterface::SCOPE_STORE, null, 1]
                 ]
             );
 

Test/Unit/Model/Environment/RemoteAddressTest.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * PAYONE Magento 2 Connector 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * PHP version 5
+ *
+ * @category  Payone
+ * @package   Payone_Magento2_Plugin
+ * @author    FATCHIP GmbH <[email protected]>
+ * @copyright 2003 - 2017 Payone GmbH
+ * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
+ * @link      http://www.payone.de
+ */
+
+namespace Payone\Core\Test\Unit\Model\Methods;
+
+use Payone\Core\Model\Environment\RemoteAddress as ClassToTest;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Payone\Core\Test\Unit\BaseTestCase;
+use Payone\Core\Test\Unit\PayoneObjectManager;
+
+class RemoteAddressTest extends BaseTestCase
+{
+    /**
+     * @var ClassToTest
+     */
+    private $classToTest;
+
+    /**
+     * @var ObjectManager|PayoneObjectManager
+     */
+    private $objectManager;
+
+    protected function setUp()
+    {
+        $this->objectManager = $this->getObjectManager();
+
+        $this->classToTest = $this->objectManager->getObject(ClassToTest::class);
+    }
+
+    public function testUseHttpXForwardedTest()
+    {
+        $result = $this->classToTest->useHttpXForwarded();
+        $this->assertNull($result);
+    }
+}

etc/adminhtml/system.xml

@@ -426,6 +426,11 @@
                     <label>Valid PAYONE IPs</label>
                     <comment>Enter valid PAYONE IPs (Format xxx.xxx.xxx.xxx). As a Wildcard You can use * </comment>
                 </field>
+                <field id="proxy_mode" translate="label" type="select" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Proxy-Mode</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <comment>If your shop is behind a Proxy. Enable this option to transmit the HTTP_X_FORWARDED_FOR</comment>
+                </field>
             </group>
             <group id="forwarding" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Transaction-Status Forwarding</label>

etc/config.xml

@@ -385,6 +385,7 @@
         <payone_misc>
             <processing>
                 <valid_ips><![CDATA[185.60.20.*]]></valid_ips>
+                <proxy_mode>0</proxy_mode>
             </processing>
             <costs>
                 <sku>delivery</sku>