Merge branch '1.9.4.x' into replace-1525

Author: fballiano

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['7.3']
+        php-versions: ['7.4']
     steps:
     - name: Checkout repository
       uses: actions/checkout@master
@@ -26,6 +26,10 @@ jobs:
         key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
         restore-keys: ${{ runner.os }}-composer-
 
+    - name: Require legacy frontend themes on v19
+      if: startsWith(github.event.release.tag_name, 'v19')
+      run: composer require --no-install --prefer-dist --no-progress --ignore-platform-req=ext-* openmage/legacy-frontend-themes
+
     - name: Require Mage_Backup on v19
       if: startsWith(github.event.release.tag_name, 'v19')
       run: composer require --no-install --prefer-dist --no-progress --ignore-platform-req=ext-* openmage/module-mage-backup
@@ -37,6 +41,9 @@ jobs:
     - name: Composer install
       run: composer install --prefer-dist --no-progress --ignore-platform-req=ext-* --no-dev
 
+    - name: Optimize autoloader
+      run: composer dump-autoload --optimize
+
     - name: Create ZIP file
       run: zip -rq openmage-${{ github.event.release.tag_name }}.zip . -x '.git/*'
 

.github/workflows/syntax-php.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        php: ['7.3', '8.1', '8.2']
+        php: ['7.4', '8.1', '8.2']
 
     name: PHP Syntax ${{ matrix.php }}
 

.github/workflows/workflow.yml

@@ -73,7 +73,7 @@ jobs:
 
   phpstan:
     name: PHPStan
-    needs: [check, composer, phpcs, php-cs-fixer]
+    needs: [check, composer]
     if: |
       needs.check.outputs.php > 0 ||
       needs.check.outputs.phpstan > 0 ||

.htaccess

@@ -197,6 +197,7 @@
     ExpiresByType text/x-javascript "access plus 1 month"
     ExpiresByType application/x-shockwave-flash "access plus 1 month"
     ExpiresByType image/x-icon "access plus 1 year"
+    ExpiresByType image/svg+xml "access plus 1 year"
     ExpiresDefault "access plus 2 days"
 </IfModule>
 

README.md

@@ -1,6 +1,6 @@
 <p align="center">
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-151-orange.svg" alt="All Contributors"></a>
+<a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-152-orange.svg" alt="All Contributors"></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 <a href="https://packagist.org/packages/openmage/magento-lts"><img src="https://poser.pugx.org/openmage/magento-lts/d/total.svg" alt="Total Downloads"></a>
 <a href="https://packagist.org/packages/openmage/magento-lts"><img src="https://poser.pugx.org/openmage/magento-lts/license.svg" alt="License"></a>
@@ -21,8 +21,8 @@ level of backwards compatibility to the official releases.
 ## Table of contents
 
 - [Requirements](#requirements)
-  - [Optional](#optional)
 - [Installation](#installation)
+  - [Manual Install](#manual-install)
   - [Composer](#composer)
   - [Git](#git)
 - [Secure your installation](#secure-your-installation)
@@ -36,7 +36,7 @@ level of backwards compatibility to the official releases.
   - [New Events](#new-events)
   - [Changes to SOAP/WSDL](#changes-to-soapwsdl)
 - [Development Environment with ddev](#development-environment-with-ddev)
-- [Development with PHP 8.1](#development-with-php-81)
+- [Development with PHP 8.1+](#development-with-php-81)
 - [PhpStorm Factory Helper](#phpstorm-factory-helper)
 - [Versioning](#versioning)
 - [Public Communication](#public-communication)
@@ -46,36 +46,80 @@ level of backwards compatibility to the official releases.
 
 ## Requirements
 
-- PHP 7.3+ (PHP 8.0 is supported, PHP 8.1 is work in progress)
+- PHP 7.4+ (PHP 8.0 is supported, PHP 8.1 supported but some warnings may be shown/logged, PHP 8.2 is usable but still being tested)
 - MySQL 5.6+ (8.0+ recommended) or MariaDB
+- optional: Redis 5.x, 6.x and 7.0.x are supported
 
 
 - PHP extension `intl` <small>since 1.9.4.19 & 20.0.17</small>
 - Command `patch` 2.7+ (or `gpatch` on MacOS/HomeBrew) <small>since 1.9.5.0 & 20.1.0</small>
 
-__Please be aware that although OpenMage is compatible that one or more extensions may not be.__
-
-### Optional
+## Installation
 
-- Redis 5+ (6.x recommended, latest verified compatible 6.0.7 with 20.x)
+### Manual Install
 
-## Installation
+Download the latest [release archive](https://github.com/OpenMage/magento-lts/releases) and extract it over your existing install. **Important:** you must download the ZIP file from a tagged version on the releases page, otherwise there will be missing dependencies.
 
 ### Composer
 
-Download the latest archive and extract it, clone the repo, or add a composer dependency to your existing project like so:
+Step 1: Create a new composer project:
 
 ```bash
-composer require "openmage/magento-lts":"^19.5.0"
+composer init
+```
+
+Step 2: Configure composer. **The below options are required.** You can see all options [here](https://github.com/AydinHassan/magento-core-composer-installer#configuration).
+
+```bash
+# Allow composer to apply patches to dependencies of magento-lts
+composer config --json extra.enable-patching true
+
+# Configure Magento core composer installer to use magento-lts as the Magento source package
+composer config extra.magento-core-package-type magento-source
+
+# Configure the root directory that magento-lts will be installed to, such as "pub", "htdocs", or "www"
+composer config extra.magento-root-dir pub
 ```
 
-To get the latest changes use:
+Step 3: Require `magento-core-composer-installer`:
+
+``` bash
+# PHP 7
+composer require "aydin-hassan/magento-core-composer-installer":"~2.0.0"
+
+# PHP 8
+composer require "aydin-hassan/magento-core-composer-installer":"^2.1.0"
+```
+
+<small>Note: be sure to select `y` if composer asks you to trust `aydin-hassan/magento-core-composer-installer`.</small>
+
+Step 4: Require `magento-lts`:
 
 ```bash
-composer require "openmage/magento-lts":"dev-main"
+# OpenMage v19
+composer require "openmage/magento-lts":"^19.4.0"
+
+# OpenMage v20
+composer require "openmage/magento-lts":"^20.0.0"
 ```
 
-<small>Note: `dev-main` is just an alias for current `1.9.4.x` branch and may change</small>
+<small>Note: be sure to select `y` if composer asks you to trust `magento-hackathon/magento-composer-installer` or `cweagans/composer-patches`.</small>
+
+To install the latest development version (may be unstable):
+
+```bash
+# OpenMage v19
+composer require "openmage/magento-lts":"1.9.4.x-dev"
+
+# OpenMage v20
+composer require "openmage/magento-lts":"20.0.x-dev"
+```
+
+When deploying to a production environment, it's recommended to optimize Composer's autoloader to speed up classes lookup time:
+
+```bash
+composer dump-autoload --optimize
+```
 
 ### Git
 
@@ -129,11 +173,14 @@ Most important changes will be listed here, all other changes since `19.4.0` can
 
 ### Between Magento 1.9.4.5 and OpenMage 19.x
 
-- bug fixes and PHP 7.x, 8.0 and 8.1 compatibility
+- bug fixes and PHP 7.x, 8.0, 8.1 and 8.2 compatibility
 - added config cache for system.xml ([#1916](https://github.com/OpenMage/magento-lts/pull/1916))
+- added frontend_type color ([#2945](https://github.com/OpenMage/magento-lts/pull/2945))
 - search for "NULL" in backend grids ([#1203](https://github.com/OpenMage/magento-lts/pull/1203))
 - removed `lib/flex` containing unused ActionScript "file uploader" files ([#2271](https://github.com/OpenMage/magento-lts/pull/2271))
 - Mage_Catalog_Model_Resource_Abstract::getAttributeRawValue() now returns `'0'` instead of `false` if the value stored in the database is `0` ([#572](https://github.com/OpenMage/magento-lts/pull/572))
+- PHP extension `intl` is required
+- Deprecation errors are not suppressed anymore
 - removed modules:
   - `Mage_Backup` ([#2811](https://github.com/OpenMage/magento-lts/pull/2811))
   - `Mage_Compiler`
@@ -145,28 +192,28 @@ Most important changes will be listed here, all other changes since `19.4.0` can
 _If you rely on those modules you can reinstall them with composer:_
 - `Mage_Backup`: `composer require openmage/module-mage-backup`
 - `Mage_PageCache`: `composer require openmage/module-mage-pagecache`
-
-### Between OpenMage 19.4.18 / 20.0.16 and 19.4.19 / 20.0.17
-
-- PHP extension `intl` is required
+- `Legacy frontend themes`: `composer require openmage/legacy-frontend-themes`
 
 ### Between OpenMage 19.x and 20.x
 
 Do not use 20.x.x if you need IE support.
 
-- removed IE conditional comments, IE styles, IE scripts and IE eot files [#1073](https://github.com/OpenMage/magento-lts/pull/1073)
-- removed frontend default themes (default, modern, iphone, german, french, blank, blue) [#1600](https://github.com/OpenMage/magento-lts/pull/1600)
-- added redis as a valid option for `global/session_save` [#1513](https://github.com/OpenMage/magento-lts/pull/1513)
-- reduce needless saves by avoiding setting `_hasDataChanges` flag [#2066](https://github.com/OpenMage/magento-lts/pull/2066)
-- removed support for `global/sales/old_fields_map` defined in XML [#921](https://github.com/OpenMage/magento-lts/pull/921)
-- removed lib/flex containing unused ActionScript "file uploader" files [#2271](https://github.com/OpenMage/magento-lts/pull/2271)
-- enabled website level config cache [#2355](https://github.com/OpenMage/magento-lts/pull/2355)
-- make overrides of Mage_Core_Model_Resource_Db_Abstract::delete respect parent api [#1257](https://github.com/OpenMage/magento-lts/pull/1257)
+- removed IE conditional comments, IE styles, IE scripts and IE eot files ([#1073](https://github.com/OpenMage/magento-lts/pull/1073))
+- removed frontend default themes (default, modern, iphone, german, french, blank, blue) ([#1600](https://github.com/OpenMage/magento-lts/pull/1600))
+- added redis as a valid option for `global/session_save` ([#1513](https://github.com/OpenMage/magento-lts/pull/1513))
+- reduce needless saves by avoiding setting `_hasDataChanges` flag ([#2066](https://github.com/OpenMage/magento-lts/pull/2066))
+- removed support for `global/sales/old_fields_map` defined in XML ([#921](https://github.com/OpenMage/magento-lts/pull/921))
+- enabled website level config cache ([#2355](https://github.com/OpenMage/magento-lts/pull/2355))
+- made overrides of Mage_Core_Model_Resource_Db_Abstract::delete respect parent api ([#1257](https://github.com/OpenMage/magento-lts/pull/1257))
+- rewrote Mage_Eav_Model_Config as cache for all eav entity and attribute reads ([#2993](https://github.com/OpenMage/magento-lts/pull/2993))
+- removed module Mage_Poll ([3098](https://github.com/OpenMage/magento-lts/pull/3098), you can install it with `composer require openmage/module-mage-poll`)
 
 For full list of changes, you can [compare tags](https://github.com/OpenMage/magento-lts/compare/1.9.4.x...20.0).
 
 ### Since OpenMage 19.5.0 / 20.1.0
 
+PHP 7.4 is now the minimum required version.
+
 Most of the 3rd party libraries/modules that were bundled in our repository were removed and migrated to composer dependencies.
 This allows for better maintenance and upgradability.
 
@@ -178,14 +225,18 @@ If your project uses OpenMage through composer then all dependencies will be man
 If you just extracted the release zip/tarball in your project's main folder then be sure to:
 - remove the old copy of aforementioned libraries from your project, you can do that with this command:
   ```bash
-  rm -rf lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend
+  rm -rf app/code/core/Zend lib/Cm lib/Credis lib/mcryptcompat lib/Pelago lib/phpseclib lib/Zend
   ```
 
-
 - download the new release zip file that is named `openmage-VERSIONNUMBER.zip`, this one is built to contain the `vendor`
   folder generated by composer, with all the dependencies in it
 - extract the zip file in your project's repository as you always did
 
+We also decided to remove our Zend_DB patches (that were stored in `app/code/core/Zend`) because they were very old and
+not compatible with the new implementations made by ZF1-Future, which is much more advanced and feature rich.
+This may generate a problem with `Zend_Db_Select' statements that do not use 'Zend_Db_Expr' to quote expressions.
+If you see SQL errors after upgrading please remember to check for this specific issue in your code.
+
 ### New Config Options
 
 - `admin/design/use_legacy_theme`
@@ -251,13 +302,7 @@ grep -rn 'urn:Magento' --include \*.xml
 - Open your site in browser
   ```bash
   ddev launch
-  ```
-
-## Development with PHP 8.1
-
-Deprecation errors are supressed by default.
-
-If you want to work on PHP 8.1 support, set environment variable `DEV_PHP_STRICT` to `1`, to show all errors.  
+  ``` 
 
 ## PhpStorm Factory Helper
 
@@ -501,6 +546,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/discountscott"><img src="https://avatars.githubusercontent.com/u/5454596?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>Scott Moore</b></sub></a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/rfeese"><img src="https://avatars.githubusercontent.com/u/7074181?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>Roger Feese</b></sub></a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/AGelzer"><img src="https://avatars.githubusercontent.com/u/34437931?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>Alexander Gelzer</b></sub></a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://gitlab.com/davidhiendl"><img src="https://avatars.githubusercontent.com/u/11006964?v=4" loading="lazy" width="100" alt=""/><br /><sub><b>David Hiendl</b></sub></a></td>
     </tr>
   </tbody>
 </table>

api.php

@@ -2,15 +2,9 @@
 /**
  * OpenMage
  *
- * 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.txt.
- * It is also available through the world-wide-web at this URL:
- * https://opensource.org/licenses/osl-3.0.php
- * 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 [email protected] so we can send you a copy immediately.
+ * It is also available at https://opensource.org/license/osl-3-0-php
  *
  * @category    Mage
  * @package     Mage
@@ -19,11 +13,6 @@
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-if (version_compare(phpversion(), '7.3.0', '<') === true) {
-    echo 'It looks like you have an invalid PHP version. OpenMage supports PHP 7.3.0 or newer';
-    exit;
-}
-
 $magentoRootDir = getcwd();
 $bootstrapFilename = $magentoRootDir . '/app/bootstrap.php';
 $mageFilename = $magentoRootDir . '/app/Mage.php';

app/Mage.php

@@ -2,15 +2,9 @@
 /**
  * OpenMage
  *
- * 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.txt.
- * It is also available through the world-wide-web at this URL:
- * https://opensource.org/licenses/osl-3.0.php
- * 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 [email protected] so we can send you a copy immediately.
+ * It is also available at https://opensource.org/license/osl-3-0-php
  *
  * @category    Mage
  * @package     Mage
@@ -214,7 +208,7 @@ public static function getOpenMageVersionInfo(): array
                 'major'     => '20',
                 'minor'     => '1',
                 'patch'     => '0',
-                'stability' => 'rc1', // beta,alpha,rc
+                'stability' => 'rc3', // beta,alpha,rc
                 'number'    => '', // 1,2,3,0.3.7,x.7.z.92 @see https://semver.org/#spec-item-9
             ];
         }
@@ -223,7 +217,7 @@ public static function getOpenMageVersionInfo(): array
             'major'     => '19',
             'minor'     => '5',
             'patch'     => '0',
-            'stability' => 'rc1', // beta,alpha,rc
+            'stability' => 'rc3', // beta,alpha,rc
             'number'    => '', // 1,2,3,0.3.7,x.7.z.92 @see https://semver.org/#spec-item-9
         ];
     }
@@ -526,7 +520,7 @@ public static function getModel($modelClass = '', $arguments = [])
      *
      * @param   string $modelClass
      * @param   array $arguments
-     * @return  Mage_Core_Model_Abstract
+     * @return  Mage_Core_Model_Abstract|false
      */
     public static function getSingleton($modelClass = '', array $arguments = [])
     {

app/bootstrap.php

@@ -2,15 +2,9 @@
 /**
  * OpenMage
  *
- * 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.txt.
- * It is also available through the world-wide-web at this URL:
- * https://opensource.org/licenses/osl-3.0.php
- * 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 [email protected] so we can send you a copy immediately.
+ * It is also available at https://opensource.org/license/osl-3-0-php
  *
  * @category    Mage
  * @package     Mage

app/code/core/Mage/Admin/Helper/Block.php

@@ -2,15 +2,9 @@
 /**
  * OpenMage
  *
- * 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.txt.
- * It is also available through the world-wide-web at this URL:
- * https://opensource.org/licenses/osl-3.0.php
- * 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 [email protected] so we can send you a copy immediately.
+ * It is also available at https://opensource.org/license/osl-3-0-php
  *
  * @category   Mage
  * @package    Mage_Admin

app/code/core/Mage/Admin/Helper/Data.php

@@ -2,15 +2,9 @@
 /**
  * OpenMage
  *
- * 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.txt.
- * It is also available through the world-wide-web at this URL:
- * https://opensource.org/licenses/osl-3.0.php
- * 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 [email protected] so we can send you a copy immediately.
+ * It is also available at https://opensource.org/license/osl-3-0-php
  *
  * @category   Mage
  * @package    Mage_Admin