first commit

classes/exception/PrestaShopDatabaseException.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+/**
+ * @since 1.5.0
+ */
+class PrestaShopDatabaseExceptionCore extends PrestaShopException
+{
+    public function __toString()
+    {
+        return $this->message;
+    }
+}

classes/exception/PrestaShopException.php

@@ -0,0 +1,238 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+/**
+ * @since 1.5.0
+ */
+class PrestaShopExceptionCore extends Exception
+{
+    /**
+     * This method acts like an error handler, if dev mode is on, display the error else use a better silent way.
+     */
+    public function displayMessage()
+    {
+        if (getenv('kernel.environment') === 'test') {
+            throw $this;
+        }
+
+        header('HTTP/1.1 500 Internal Server Error');
+        if (ToolsCore::isPHPCLI()) {
+            echo get_class($this) . ' in ' . $this->getFile() . ' line ' . $this->getLine() . "\n";
+            echo $this->getTraceAsString() . "\n";
+        } elseif (_PS_MODE_DEV_) {
+            // Display error message
+            echo '<style>
+                #psException{font-family: Verdana; font-size: 14px}
+                #psException h2{color: #F20000}
+                #psException p{padding-left: 20px}
+                #psException ul li{margin-bottom: 10px}
+                #psException a{font-size: 12px; color: #000000}
+                #psException .psTrace, #psException .psArgs{display: none}
+                #psException pre{border: 1px solid #236B04; background-color: #EAFEE1; padding: 5px; font-family: Courier; width: 99%; overflow-x: auto; margin-bottom: 30px;}
+                #psException .psArgs pre{background-color: #F1FDFE;}
+                #psException pre .selected{color: #F20000; font-weight: bold;}
+            </style>';
+            echo '<div id="psException">';
+            echo '<h2>[' . get_class($this) . ']</h2>';
+            echo $this->getExtendedMessage();
+
+            $this->displayFileDebug($this->getFile(), $this->getLine());
+
+            // Display debug backtrace
+            echo '<ul>';
+            foreach ($this->getTrace() as $id => $trace) {
+                $relative_file = (isset($trace['file'])) ? ltrim(str_replace([_PS_ROOT_DIR_, '\\'], ['', '/'], $trace['file']), '/') : '';
+                $current_line = (isset($trace['line'])) ? $trace['line'] : '';
+                if (defined('_PS_ADMIN_DIR_')) {
+                    $relative_file = str_replace(basename(_PS_ADMIN_DIR_) . DIRECTORY_SEPARATOR, 'admin' . DIRECTORY_SEPARATOR, $relative_file);
+                }
+                echo '<li>';
+                echo '<b>' . ((isset($trace['class'])) ? $trace['class'] : '') . ((isset($trace['type'])) ? $trace['type'] : '') . $trace['function'] . '</b>';
+                echo ' - <a style="font-size: 12px; color: #000000; cursor:pointer; color: blue;" onclick="document.getElementById(\'psTrace_' . $id . '\').style.display = (document.getElementById(\'psTrace_' . $id . '\').style.display != \'block\') ? \'block\' : \'none\'; return false">[line ' . $current_line . ' - ' . $relative_file . ']</a>';
+
+                if (isset($trace['args']) && count($trace['args'])) {
+                    echo ' - <a style="font-size: 12px; color: #000000; cursor:pointer; color: blue;" onclick="document.getElementById(\'psArgs_' . $id . '\').style.display = (document.getElementById(\'psArgs_' . $id . '\').style.display != \'block\') ? \'block\' : \'none\'; return false">[' . count($trace['args']) . ' Arguments]</a>';
+                }
+
+                if ($relative_file) {
+                    $this->displayFileDebug($trace['file'], $trace['line'], $id);
+                }
+                if (isset($trace['args']) && count($trace['args'])) {
+                    $args = $this->hideCriticalArgs($trace);
+                    $this->displayArgsDebug($args, $id);
+                }
+                echo '</li>';
+            }
+            echo '</ul>';
+            echo '</div>';
+        } else {
+            // If not in mode dev, display an error page
+            if (file_exists(_PS_ROOT_DIR_ . '/error500.html')) {
+                echo file_get_contents(_PS_ROOT_DIR_ . '/error500.html');
+            }
+        }
+        // Log the error in the disk
+        $this->logError();
+        //We only need the error code 1 in cli context
+        exit((int) ToolsCore::isPHPCLI());
+    }
+
+    /**
+     * Display lines around current line.
+     *
+     * @param string $file
+     * @param int $line
+     * @param string $id
+     */
+    protected function displayFileDebug($file, $line, $id = null)
+    {
+        $lines = file($file);
+        $offset = $line - 6;
+        $total = 11;
+        if ($offset < 0) {
+            $total += $offset;
+            $offset = 0;
+        }
+        $lines = array_slice($lines, $offset, $total);
+        ++$offset;
+
+        echo '<div class="psTrace" id="psTrace_' . $id . '" ' . ((null === $id ? 'style="display: block"' : '')) . '><pre>';
+        foreach ($lines as $k => $l) {
+            $string = ($offset + $k) . '. ' . htmlspecialchars($l);
+            if ($offset + $k == $line) {
+                echo '<span class="selected">' . $string . '</span>';
+            } else {
+                echo $string;
+            }
+        }
+        echo '</pre></div>';
+    }
+
+    /**
+     * Prevent critical arguments to be displayed in the debug trace page (e.g. database password)
+     * Returns the array of args with critical arguments replaced by placeholders.
+     *
+     * @param array $trace
+     *
+     * @return array
+     */
+    protected function hideCriticalArgs(array $trace)
+    {
+        $args = $trace['args'];
+        if (empty($trace['class']) || empty($trace['function'])) {
+            return $args;
+        }
+
+        $criticalParameters = [
+            'pwd',
+            'pass',
+            'passwd',
+            'password',
+            'database',
+            'server',
+        ];
+        $hiddenArgs = [];
+
+        try {
+            $class = new \ReflectionClass($trace['class']);
+            /** @var \ReflectionMethod $method */
+            $method = $class->getMethod($trace['function']);
+            /** @var \ReflectionParameter $parameter */
+            foreach ($method->getParameters() as $argIndex => $parameter) {
+                if ($argIndex >= count($args)) {
+                    break;
+                }
+
+                if (in_array(strtolower($parameter->getName()), $criticalParameters)) {
+                    $hiddenArgs[] = '**hidden_' . $parameter->getName() . '**';
+                } else {
+                    $hiddenArgs[] = $args[$argIndex];
+                }
+            }
+        } catch (ReflectionException $e) {
+            //In worst case scenario there are some critical args we could't detect so we return an empty array
+        }
+
+        return $hiddenArgs;
+    }
+
+    /**
+     * Display arguments list of traced function.
+     *
+     * @param array $args List of arguments
+     * @param string $id ID of argument
+     */
+    protected function displayArgsDebug($args, $id)
+    {
+        echo '<div class="psArgs" id="psArgs_' . $id . '"><pre>';
+        foreach ($args as $arg => $value) {
+            echo '<b>Argument [' . Tools::safeOutput($arg) . "]</b>\n";
+            echo Tools::safeOutput(print_r($value, true));
+            echo "\n";
+        }
+        echo '</pre>';
+    }
+
+    /**
+     * Log the error on the disk.
+     */
+    protected function logError()
+    {
+        $logger = new FileLogger();
+        $logger->setFilename(_PS_ROOT_DIR_ . '/var/logs/' . date('Ymd') . '_exception.log');
+        $logger->logError($this->getExtendedMessage(false));
+    }
+
+    /**
+     * @deprecated 1.5.5
+     */
+    protected function getExentedMessage($html = true)
+    {
+        Tools::displayAsDeprecated('Use getExtendedMessage instead');
+
+        return $this->getExtendedMessage($html);
+    }
+
+    /**
+     * Return the content of the Exception.
+     *
+     * @return string content of the exception
+     */
+    protected function getExtendedMessage($html = true)
+    {
+        $format = '<p><b>%s</b><br /><i>at line </i><b>%d</b><i> in file </i><b>%s</b></p>';
+        if (!$html) {
+            $format = strip_tags(str_replace('<br />', ' ', $format));
+        }
+
+        return sprintf(
+            $format,
+            Tools::safeOutput($this->getMessage(), true),
+            $this->getLine(),
+            ltrim(str_replace([_PS_ROOT_DIR_, '\\'], ['', '/'], $this->getFile()), '/')
+        );
+    }
+}

classes/exception/PrestaShopModuleException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+/**
+ * @since 1.5.0
+ */
+class PrestaShopModuleExceptionCore extends PrestaShopException
+{
+}

classes/exception/PrestaShopObjectNotFoundException.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+class PrestaShopObjectNotFoundExceptionCore extends PrestaShopException
+{
+}

classes/exception/PrestaShopPaymentException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+/**
+ * @since 1.5.0
+ */
+class PrestaShopPaymentExceptionCore extends PrestaShopException
+{
+}

classes/exception/index.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+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;