update

modules/autoupgrade/classes/Xml/ChecksumCompare.php

@@ -0,0 +1,233 @@
+<?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 Academic Free License 3.0 (AFL-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/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.
+ *
+ * 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/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ */
+
+namespace PrestaShop\Module\AutoUpgrade\Xml;
+
+use PrestaShop\Module\AutoUpgrade\UpgradeTools\FilesystemAdapter;
+use SimpleXMLElement;
+
+class ChecksumCompare
+{
+    /**
+     * @var FileLoader
+     */
+    private $fileLoader;
+    /**
+     * @var FilesystemAdapter
+     */
+    private $filesystemAdapter;
+
+    /**
+     * @var array{'mail':string[],'translation':string[],'core':string[]}|false
+     */
+    private $changed_files = [
+        'mail' => [],
+        'translation' => [],
+        'core' => [],
+    ];
+
+    public function __construct(FileLoader $fileLoader, FilesystemAdapter $filesystemAdapter)
+    {
+        $this->fileLoader = $fileLoader;
+        $this->filesystemAdapter = $filesystemAdapter;
+    }
+
+    /**
+     * @return false|array{'modified': string[], "deleted": string[]}
+     */
+    public function getFilesDiffBetweenVersions(string $version1, ?string $version2)
+    {
+        $checksum1 = $this->fileLoader->getXmlMd5File($version1);
+        $checksum2 = $this->fileLoader->getXmlMd5File($version2);
+        if ($checksum1) {
+            $v1 = $this->md5FileAsArray($checksum1->ps_root_dir[0]);
+        }
+        if ($checksum2) {
+            $v2 = $this->md5FileAsArray($checksum2->ps_root_dir[0]);
+        }
+        if (empty($v1) || empty($v2)) {
+            return false;
+        }
+
+        return $this->compareReleases($v1, $v2);
+    }
+
+    /**
+     * returns an array of files which are present in PrestaShop version $version and has been modified
+     * in the current filesystem.
+     *
+     * @return array{'mail':string[],'translation':string[],'core':string[]}|false
+     */
+    public function getTamperedFilesOnShop(string $version)
+    {
+        if (is_array($this->changed_files) && count($this->changed_files['core']) == 0) {
+            $checksum = $this->fileLoader->getXmlMd5File($version);
+            if (!$checksum) {
+                $this->changed_files = false;
+            } else {
+                $this->browseXmlAndCompare($checksum->ps_root_dir[0]);
+            }
+        }
+
+        return $this->changed_files;
+    }
+
+    public function isAuthenticPrestashopVersion(string $version): bool
+    {
+        return !$this->getTamperedFilesOnShop($version);
+    }
+
+    /**
+     * returns an array of files which.
+     *
+     * @param array<string, string|mixed[]> $v1 result of method $this->md5FileAsArray()
+     * @param array<string, string|mixed[]> $v2 result of method $this->md5FileAsArray()
+     * @param bool $show_modif if set to false, the method will only
+     *                         list deleted files
+     * @param string $path
+     *                     deleted files in version $v2. Otherwise, only deleted.
+     *
+     * @return array{'modified': string[], "deleted": string[]}
+     *
+     *@internal Made public for tests
+     */
+    public function compareReleases(array $v1, array $v2, bool $show_modif = true, string $path = '/'): array
+    {
+        // in that array the list of files present in v1 deleted in v2
+        static $deletedFiles = [];
+        // in that array the list of files present in v1 modified in v2
+        static $modifiedFiles = [];
+
+        foreach ($v1 as $file => $md5) {
+            if ($this->filesystemAdapter->isFileSkipped($file, $path . $file, 'upgrade', '')) {
+                continue;
+            }
+            if (is_array($md5)) {
+                $subpath = $path . $file;
+                if (isset($v2[$file]) && is_array($v2[$file])) {
+                    $this->compareReleases($md5, $v2[$file], $show_modif, $path . $file . '/');
+                } else { // also remove old dir
+                    $deletedFiles[] = $subpath;
+                }
+            } else {
+                if (in_array($file, array_keys($v2))) {
+                    if ($show_modif && ($v1[$file] != $v2[$file])) {
+                        $modifiedFiles[] = $path . $file;
+                    }
+                } else {
+                    $deletedFiles[] = $path . $file;
+                }
+            }
+        }
+
+        return ['deleted' => $deletedFiles, 'modified' => $modifiedFiles];
+    }
+
+    /**
+     * Compare the md5sum of the current files with the md5sum of the original.
+     *
+     * @param string[] $current_path
+     */
+    protected function browseXmlAndCompare(SimpleXMLElement $node, array &$current_path = [], int $level = 1): void
+    {
+        foreach ($node as $child) {
+            if (is_object($child) && $child->getName() == 'dir') {
+                $current_path[$level] = (string) $child['name'];
+                $this->browseXmlAndCompare($child, $current_path, $level + 1);
+            } elseif (is_object($child) && $child->getName() == 'md5file') {
+                // We will store only relative path.
+                // absolute path is only used for file_exists and compare
+                $relative_path = '';
+                for ($i = 1; $i < $level; ++$i) {
+                    $relative_path .= $current_path[$i] . '/';
+                }
+                $relative_path .= (string) $child['name'];
+
+                // TODO: Drop use of constants and use args instead
+                $fullpath = _PS_ROOT_DIR_ . DIRECTORY_SEPARATOR . $relative_path;
+                $fullpath = str_replace('ps_root_dir', _PS_ROOT_DIR_, $fullpath);
+
+                // replace default admin dir by current one
+                $fullpath = str_replace(_PS_ROOT_DIR_ . '/admin', _PS_ADMIN_DIR_, $fullpath);
+                $fullpath = str_replace(_PS_ROOT_DIR_ . DIRECTORY_SEPARATOR . 'admin', _PS_ADMIN_DIR_, $fullpath);
+                if (!file_exists($fullpath)) {
+                    // Not stored in a list as we do nothing with it.
+                } elseif (!$this->compareChecksum($fullpath, (string) $child) && substr(str_replace(DIRECTORY_SEPARATOR, '-', $relative_path), 0, 19) != 'modules/autoupgrade') {
+                    $this->addChangedFile($relative_path);
+                }
+                // else, file is original (and ok)
+            }
+        }
+    }
+
+    /**
+     * @return array<string, string|mixed[]>
+     */
+    protected function md5FileAsArray(SimpleXMLElement $node, string $dir = '/')
+    {
+        $array = [];
+        foreach ($node as $child) {
+            if (is_object($child) && $child->getName() == 'dir') {
+                $dir = (string) $child['name'];
+                /**
+                 * $current_path = $dir.(string)$child['name'];.
+                 *
+                 * @todo : something else than array pop ?
+                 */
+                $dir_content = $this->md5FileAsArray($child, $dir);
+                $array[$dir] = $dir_content;
+            } elseif (is_object($child) && $child->getName() == 'md5file') {
+                $array[(string) $child['name']] = (string) $child;
+            }
+        }
+
+        return $array;
+    }
+
+    /** populate $this->changed_files with $path
+     * in sub arrays  mail, translation and core items.
+     *
+     * @param string $path filepath to add, relative to _PS_ROOT_DIR_
+     */
+    protected function addChangedFile(string $path): void
+    {
+        if (strpos($path, 'mails/') !== false) {
+            $this->changed_files['mail'][] = $path;
+        } elseif (strpos($path, '/en.php') !== false || strpos($path, '/fr.php') !== false
+            || strpos($path, '/es.php') !== false || strpos($path, '/it.php') !== false
+            || strpos($path, '/de.php') !== false || strpos($path, 'translations/') !== false) {
+            $this->changed_files['translation'][] = $path;
+        } else {
+            $this->changed_files['core'][] = $path;
+        }
+    }
+
+    protected function compareChecksum(string $filepath, string $md5sum): bool
+    {
+        return md5_file($filepath) == $md5sum;
+    }
+}

modules/autoupgrade/classes/Xml/FileLoader.php

@@ -0,0 +1,102 @@
+<?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 Academic Free License 3.0 (AFL-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/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.
+ *
+ * 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/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ */
+
+namespace PrestaShop\Module\AutoUpgrade\Xml;
+
+use Configuration;
+use PrestaShop\Module\AutoUpgrade\Tools14;
+use PrestaShop\Module\AutoUpgrade\Upgrader;
+use SimpleXMLElement;
+
+class FileLoader
+{
+    const BASE_URL_MD5_FILES = 'https://api.prestashop.com/xml/md5/';
+    const URL_CHANNELS_FILE = 'https://api.prestashop.com/xml/channel.xml';
+
+    /** @var array<string, string> */
+    public $version_md5 = [];
+
+    /**
+     * @return SimpleXMLElement|false
+     */
+    public function getXmlFile(string $xml_localfile, string $xml_remotefile, bool $refresh = false)
+    {
+        // @TODO : this has to be moved in autoupgrade.php > install method
+        if (!is_dir(_PS_ROOT_DIR_ . '/config/xml')) {
+            if (is_file(_PS_ROOT_DIR_ . '/config/xml')) {
+                unlink(_PS_ROOT_DIR_ . '/config/xml');
+            }
+            mkdir(_PS_ROOT_DIR_ . '/config/xml', 0777);
+        }
+        if ($refresh || !file_exists($xml_localfile) || @filemtime($xml_localfile) < (time() - (3600 * Upgrader::DEFAULT_CHECK_VERSION_DELAY_HOURS))) {
+            $xml_string = Tools14::file_get_contents($xml_remotefile, false, stream_context_create(['http' => ['timeout' => 10]]));
+            $xml = @simplexml_load_string($xml_string);
+            if ($xml !== false) {
+                file_put_contents($xml_localfile, $xml_string);
+            }
+        } else {
+            $xml = @simplexml_load_file($xml_localfile);
+        }
+
+        return $xml;
+    }
+
+    /**
+     * return xml containing the list of all default PrestaShop files for version $version,
+     * and their respective md5sum.
+     *
+     * @return SimpleXMLElement|false if error
+     */
+    public function getXmlMd5File(?string $version, bool $refresh = false)
+    {
+        if (isset($this->version_md5[$version])) {
+            return @simplexml_load_file($this->version_md5[$version]);
+        }
+
+        return $this->getXmlFile(_PS_ROOT_DIR_ . '/config/xml/' . $version . '.xml', self::BASE_URL_MD5_FILES . $version . '.xml', $refresh);
+    }
+
+    /**
+     * @return SimpleXMLElement|false
+     */
+    public function getXmlChannel(bool $refresh = false)
+    {
+        $xml = $this->getXmlFile(
+            _PS_ROOT_DIR_ . '/config/xml/' . pathinfo(self::URL_CHANNELS_FILE, PATHINFO_BASENAME),
+            self::URL_CHANNELS_FILE,
+            $refresh
+        );
+        if ($refresh) {
+            // TODO: Check this is triggered anywhere
+            if (class_exists('Configuration', false)) {
+                Configuration::updateValue('PS_LAST_VERSION_CHECK', time());
+            }
+        }
+
+        return $xml;
+    }
+}