Initial commit

modules/ps_mbo/src/ExternalContentProvider/ExternalContentProvider.php

@@ -0,0 +1,106 @@
+<?php
+/**
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShop\Module\Mbo\ExternalContentProvider;
+
+use Closure;
+use PrestaShop\CircuitBreaker\FactorySettings;
+use PrestaShop\CircuitBreaker\SimpleCircuitBreakerFactory;
+use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class ExternalContentProvider implements ExternalContentProviderInterface
+{
+    const ALLOWED_FAILURES = 2;
+
+    const TIMEOUT_SECONDS = 0.6;
+
+    const THRESHOLD_SECONDS = 3600; // Retry in 1 hour
+
+    /**
+     * @var SimpleCircuitBreakerFactory
+     */
+    private $circuitBreakerFactory;
+
+    /**
+     * @var OptionsResolver
+     */
+    private $optionsResolver;
+
+    /**
+     * Constructor.
+     */
+    public function __construct()
+    {
+        $this->circuitBreakerFactory = new SimpleCircuitBreakerFactory();
+        $this->optionsResolver = new OptionsResolver();
+        $this->configureOptions();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws ServiceUnavailableHttpException
+     */
+    public function getContent($url, array $options = [])
+    {
+        $settings = $this->optionsResolver->resolve($options);
+
+        $apiSettings = new FactorySettings(
+            $settings['failures'],
+            $settings['timeout'],
+            $settings['threshold']
+        );
+
+        $circuitBreaker = $this->circuitBreakerFactory->create($apiSettings);
+
+        return $circuitBreaker->call(
+            $url,
+            $settings['client_options'],
+            $this->circuitBreakerFallback()
+        );
+    }
+
+    private function configureOptions()
+    {
+        $this->optionsResolver->setDefaults([
+            'failures' => self::ALLOWED_FAILURES,
+            'timeout' => self::TIMEOUT_SECONDS,
+            'threshold' => self::THRESHOLD_SECONDS,
+            'client_options' => [],
+        ]);
+        $this->optionsResolver->setAllowedTypes('failures', 'numeric');
+        $this->optionsResolver->setAllowedTypes('timeout', 'numeric');
+        $this->optionsResolver->setAllowedTypes('threshold', 'numeric');
+        $this->optionsResolver->setAllowedTypes('client_options', 'array');
+    }
+
+    /**
+     * Called by CircuitBreaker if the service is unavailable
+     *
+     * @return Closure
+     */
+    private function circuitBreakerFallback()
+    {
+        return function () {
+            throw new ServiceUnavailableHttpException(self::THRESHOLD_SECONDS);
+        };
+    }
+}

modules/ps_mbo/src/ExternalContentProvider/ExternalContentProviderInterface.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShop\Module\Mbo\ExternalContentProvider;
+
+interface ExternalContentProviderInterface
+{
+    /**
+     * @param string $url
+     * @param array $options
+     *
+     * @return string
+     */
+    public function getContent($url, array $options = []);
+}

modules/ps_mbo/src/ExternalContentProvider/index.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;