Improvements to Maho's autoloaders

app/Mage.php

@@ -12,68 +12,50 @@
 
 define('DS', DIRECTORY_SEPARATOR);
 define('PS', PATH_SEPARATOR);
-if (file_exists(__DIR__ . '/vendor/mahocommerce/maho')) {
-    define('BP', dirname(getcwd()));
-} elseif (str_contains(__DIR__, '/vendor/mahocommerce/maho')) {
-    define('BP', str_replace('/vendor/mahocommerce/maho/app', '', __DIR__));
-} else {
-    define('BP', dirname(__DIR__));
-}
+define('BP', MAHO_ROOT_DIR);
 
-Mage::register('original_include_path', get_include_path());
+/*
+ * Require Composer autoloader and set include paths
+ * @var \Composer\Autoload\ClassLoader $composerClassLoader
+ */
+$composerClassLoader = require BP . '/vendor/autoload.php';
+set_include_path(implode(PS, \Maho\MahoAutoload::generatePaths(BP)) . PS . get_include_path());
 
 if (!empty($_SERVER['MAGE_IS_DEVELOPER_MODE']) || !empty($_ENV['MAGE_IS_DEVELOPER_MODE'])) {
     Mage::setIsDeveloperMode(true);
     ini_set('display_errors', '1');
     ini_set('error_prepend_string', '<pre>');
     ini_set('error_append_string', '</pre>');
-}
 
-/**
- * Set include path
- */
-$paths = [];
-$paths[] = BP . '/app/code/local';
-$paths[] = BP . '/app/code/community';
-$paths[] = BP . '/app/code/core';
-$paths[] = BP . '/vendor/mahocommerce/maho/app/code/core';
-$paths[] = BP . '/lib';
-$paths[] = BP . '/vendor/mahocommerce/maho/lib';
-$appPath = implode(PS, $paths);
-set_include_path($appPath . PS . Mage::registry('original_include_path'));
-include_once "Mage/Core/functions.php";
-include_once "Varien/Autoload.php";
-
-Varien_Autoload::register();
-require_once BP . DS . 'vendor' . DS . 'autoload.php';
-
-$paths = require BP . '/vendor/composer/include_paths.php';
-$paths[] = BP . '/app/code/local';
-$paths[] = BP . '/app/code/community';
-$paths[] = BP . '/app/code/core';
-$allModules = mahoGetComposerInstallationData()[1];
-foreach ($allModules as $module) {
-    if (str_contains($module, 'mahocommerce/maho')) {
-        continue;
-    }
-    $paths[] = "$module/app/code/local";
-    $paths[] = "$module/app/code/community";
-    $paths[] = "$module/app/code/core";
-}
-$paths[] = BP . '/vendor/mahocommerce/maho/app/code/core';
-$paths[] = BP . '/lib';
-foreach ($allModules as $module) {
-    if (str_contains($module, 'mahocommerce/maho')) {
-        continue;
+    // Fix for overriding zf1-future during development
+    ini_set('opcache.revalidate_path', 1);
+
+    // Check if we used `composer dump --optimize-autoloader` in development
+    $classMap = $composerClassLoader->getClassMap();
+    if (isset($classMap['Mage_Core_Model_App'])) {
+        Mage::addBootupWarning('Optimized autoloader detected in developer mode.');
     }
-    $paths[] = "$module/lib";
+
+    // Reload PSR-0 namespaces and controller classmap during development in case new files are added
+    $prefixes = $composerClassLoader->getPrefixes();
+    foreach (\Maho\MahoAutoload::generatePsr0(BP) as $prefix => $paths) {
+        $prefixes[$prefix] ??= [];
+        if (count($prefixes[$prefix])) {
+            $prefixes[$prefix] = array_diff($prefixes[$prefix], $paths);
+        }
+        array_push($prefixes[$prefix], ...$paths);
+        $composerClassLoader->set($prefix, $paths);
+    }
+    $composerClassLoader->addClassMap(\Maho\MahoAutoload::generateControllerClassMap(BP));
 }
-$paths[] = BP . '/vendor/mahocommerce/maho/lib';
-$appPath = implode(PS, $paths);
-set_include_path($appPath . PS . Mage::registry('original_include_path'));
 
-/* Support additional includes, such as composer's vendor/autoload.php files */
-foreach (glob(BP . DS . 'app' . DS . 'etc' . DS . 'includes' . DS . '*.php') as $path) {
+require_once __DIR__ . '/code/core/Mage/Core/functions.php';
+
+/**
+ * Support additional includes, originally used for OpenMage composer support
+ * See: https://github.com/OpenMage/magento-lts/pull/559
+ */
+foreach (glob(BP . '/app/etc/includes/*.php') as $path) {
     include_once $path;
 }
 
@@ -604,6 +586,13 @@ public static function throwException($message, $messageStorage = null)
         throw new Mage_Core_Exception($message);
     }
 
+    public static function addBootupWarning(string $message)
+    {
+        $messages = Mage::registry('bootup_warnings') ?? [];
+        $messages[] = $message;
+        Mage::register('bootup_warnings', $message);
+    }
+
     /**
      * Get initialized application object.
      *
@@ -640,7 +629,7 @@ public static function init($code = '', $type = 'store', $options = [], $modules
     {
         try {
             self::setRoot();
-            self::$_app     = new Mage_Core_Model_App();
+            self::$_app = new Mage_Core_Model_App();
             self::_setIsInstalled($options);
             self::_setConfigModel($options);
 

app/code/core/Mage/Adminhtml/Model/Observer.php

@@ -17,6 +17,14 @@
  */
 class Mage_Adminhtml_Model_Observer
 {
+    public function displayBootupWarnings($observer)
+    {
+        $bootupWarnings = Mage::registry('bootup_warnings') ?? [];
+        foreach ($bootupWarnings as $message) {
+            Mage::getSingleton('adminhtml/session')->addWarning("Bootup warning: $message");
+        }
+    }
+
     public function bindLocale($observer)
     {
         if ($locale = $observer->getEvent()->getLocale()) {

app/code/core/Mage/Adminhtml/controllers/Sales/Order/EditController.php

@@ -10,8 +10,6 @@
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-require_once 'CreateController.php';
-
 /**
  * Adminhtml sales order edit controller
  *

app/code/core/Mage/Adminhtml/controllers/System/Convert/GuiController.php

@@ -10,8 +10,6 @@
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-include_once 'ProfileController.php';
-
 /**
  * Convert GUI admin controller
  *

app/code/core/Mage/Adminhtml/etc/config.xml

@@ -95,6 +95,14 @@
                     </auth>
                 </observers>
             </controller_action_predispatch>
+            <controller_action_layout_generate_blocks_before>
+                <observers>
+                    <display_bootup_warnings>
+                        <class>adminhtml/observer</class>
+                        <method>displayBootupWarnings</method>
+                    </display_bootup_warnings>
+                </observers>
+            </controller_action_layout_generate_blocks_before>
             <core_locale_set_locale>
                 <observers>
                     <bind_locale>

app/code/core/Mage/Api/Model/Wsdl/Config.php

@@ -113,6 +113,8 @@ public function init()
             }
         }
 
+        $moduleDir = Mage::getConfig()->getModuleDir('etc', 'Mage_Api');
+
         $mergeWsdl = new Mage_Api_Model_Wsdl_Config_Base();
         $mergeWsdl->setHandler($this->getHandler());
 
@@ -121,20 +123,22 @@ public function init()
              * Exclude Mage_Api wsdl xml file because it used for previous version
              * of API wsdl declaration
              */
-            $mergeWsdl->addLoadedFile('app/code/core/Mage/Api/etc/wsi.xml');
+            $mergeWsdl->addLoadedFile(mahoFindFileInIncludePath("$moduleDir/wsi.xml"));
+
+            // Base wsi file
+            $this->loadFile(mahoFindFileInIncludePath("$moduleDir/wsi.xml"));
 
-            $baseWsdlFile = 'app/code/core/Mage/Api/etc/wsi.xml';
-            $this->loadFile($baseWsdlFile);
             Mage::getConfig()->loadModulesConfiguration('wsi.xml', $this, $mergeWsdl);
         } else {
             /**
              * Exclude Mage_Api wsdl xml file because it used for previous version
              * of API wsdl declaration
              */
-            $mergeWsdl->addLoadedFile('app/code/core/Mage/Api/etc/wsdl.xml');
+            $mergeWsdl->addLoadedFile(mahoFindFileInIncludePath("$moduleDir/wsdl.xml"));
+
+            // Base wsdl file
+            $this->loadFile(mahoFindFileInIncludePath("$moduleDir/wsdl2.xml"));
 
-            $baseWsdlFile = 'app/code/core/Mage/Api/etc/wsdl2.xml';
-            $this->loadFile($baseWsdlFile);
             Mage::getConfig()->loadModulesConfiguration('wsdl.xml', $this, $mergeWsdl);
         }
 

app/code/core/Mage/Bundle/controllers/Adminhtml/Bundle/Product/EditController.php

@@ -10,8 +10,6 @@
  * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-require_once 'Mage/Adminhtml/controllers/Catalog/ProductController.php';
-
 /**
  * Adminhtml bundle product edit
  *

app/code/core/Mage/Core/Controller/Varien/Router/Standard.php

@@ -296,18 +296,12 @@ protected function _validateControllerInstance($controllerInstance)
      */
     protected function _validateControllerClassName($realModule, $controller)
     {
-        $controllerFileName = $this->getControllerFileName($realModule, $controller);
-        if (!$this->validateControllerFileName($controllerFileName)) {
-            return false;
-        }
-
         $controllerClassName = $this->getControllerClassName($realModule, $controller);
         if (!$controllerClassName) {
             return false;
         }
 
-        // include controller file if needed
-        if (!$this->_includeControllerClass($controllerFileName, $controllerClassName)) {
+        if (!class_exists($controllerClassName)) {
             return false;
         }
 
@@ -333,6 +327,7 @@ protected function _inludeControllerClass($controllerFileName, $controllerClassN
      * @param string $controllerFileName
      * @param string $controllerClassName
      * @return bool
+     * @deprecated
      */
     protected function _includeControllerClass($controllerFileName, $controllerClassName)
     {
@@ -412,6 +407,7 @@ public function getRouteByFrontName($frontName)
      * @param string $realModule
      * @param string $controller
      * @return string
+     * @deprecated
      */
     public function getControllerFileName($realModule, $controller)
     {
@@ -429,6 +425,7 @@ public function getControllerFileName($realModule, $controller)
     /**
      * @param string $fileName
      * @return bool
+     * @deprecated
      */
     public function validateControllerFileName($fileName)
     {