migrate to Composer autoloader

Author: pifou25

.github/workflows/phpstan.yaml

@@ -18,7 +18,11 @@ jobs:
           php-version: 7.4
 
       - name: Install Dependencies
-        run: composer update --ignore-platform-reqs
+        run: |
+          # copy common.config.php
+          cp core/config/common.config.sample.php  core/config/common.config.php 
+          # install composer dependencies
+          composer update --ignore-platform-reqs
 
       - name: Setup PHP 8.2 for PHPStan
         uses: shivammathur/setup-php@v2

composer.json

@@ -15,5 +15,21 @@
     "platform": {
       "php": "7.4"
     }
+  },
+  "autoload": {
+    "psr-4": {
+      "Jeedom\\plugins\\": "plugins/"
+    },
+    "files": [
+      "core/config/common.config.php",
+      "core/php/utils.inc.php",
+      "core/config/jeedom.config.php",
+      "core/config/compatibility.config.php"
+    ],
+    "classmap": [
+      "core/class/",
+      "core/com/",
+      "core/repo/"
+    ]
   }
 }

core/class/translate.class.php

@@ -215,7 +215,3 @@ public static function setLanguage($_langage) {
 
 	/*     * *********************Methode d'instance************************* */
 }
-
-function __($_content, $_name, $_backslash = false) {
-	return translate::sentence(str_replace("\'", "'", $_content), $_name, $_backslash);
-}

core/class/update.class.php

@@ -360,6 +360,9 @@ public function doUpdate() {
 						if (file_exists($cibDir)) {
 							rrmdir($cibDir);
 						}
+						// re generate composer autoloader
+						$result = shell_exec(system::getCmdSudo() . ' composer dump-autoload --optimize --working-dir $WEBSERVER_HOME');
+						log::add(__CLASS__, 'debug', "Composer autoloader dump result:\n$result");
 					} else {
 						throw new Exception(__("Impossible de décompresser l'archive zip", __FILE__) . ' : ' . $tmp . ' => ' . ZipErrorMessage($res));
 					}

core/php/core.inc.php

@@ -17,17 +17,6 @@
 */
 date_default_timezone_set('Europe/Brussels');
 require_once __DIR__ . '/../../vendor/autoload.php';
-require_once __DIR__ . '/../config/common.config.php';
-require_once __DIR__ . '/../class/DB.class.php';
-require_once __DIR__ . '/../class/config.class.php';
-require_once __DIR__ . '/../class/jeedom.class.php';
-require_once __DIR__ . '/../class/plugin.class.php';
-require_once __DIR__ . '/../class/translate.class.php';
-require_once __DIR__ . '/utils.inc.php';
-include_file('core', 'jeedom', 'config');
-include_file('core', 'compatibility', 'config');
-include_file('core', 'utils', 'class');
-include_file('core', 'log', 'class');
 
 try {
 	$configs = config::byKeys(array('timezone', 'log::level'));
@@ -46,18 +35,14 @@
 } catch (Error $e) {
 }
 
+/**
+ * Autoload function for specific Jeedom classes
+ * this function is called after the default Composer autoloader
+ * it will load specific classes such as Cmd, Real, etc.
+ * for plugins that do not use namespaces or Composer autoloading
+ */
 function jeedomAutoload($_classname) {
-	/* core class always in /core/class : */
-	$path = __DIR__ . "/../../core/class/$_classname.class.php";
-	if (file_exists($path)) {
-		include_file('core', $_classname, 'class');
-	} else if (substr($_classname, 0, 4) === 'com_') {
-		/* class com_$1 in /core/com/$1.com.php */
-		include_file('core', substr($_classname, 4), 'com');
-	} else if (substr($_classname, 0, 5) === 'repo_') {
-		/* class repo_$1 in /core/repo/$1.repo.php */
-		include_file('core', substr($_classname, 5), 'repo');
-	} else if (strpos($_classname, '\\') === false && strpos($_classname, '/') === false) {
+	if (strpos($_classname, '\\') === false && strpos($_classname, '/') === false) {
 		/* autoload for plugins : no namespace */
 		$classname = str_replace(array('Real', 'Cmd'), '', $_classname);
 		$plugin_active = config::byKey('active', $classname, null);
@@ -69,12 +54,12 @@ function jeedomAutoload($_classname) {
 			try {
 				include_file('core', $classname, 'class', $classname);
 			} catch (Exception $e) {
-				
+				log::add('jeedom', 'error', 'Error loading class ' . $classname . ': ' . $e->getMessage());
 			} catch (Error $e) {
-				
+				log::add('jeedom', 'error', 'Error loading class ' . $classname . ': ' . $e->getMessage());
 			}
 		}
 	}
 }
 
-spl_autoload_register('jeedomAutoload', true, true);
+spl_autoload_register('jeedomAutoload', false, false);

core/php/utils.inc.php

@@ -1839,3 +1839,10 @@ function implode_recursive($_array, $_separator, $_key = '') {
 	}
 	return $result;
 }
+
+/**
+ * alias for translate::sentence
+ */
+function __($_content, $_name, $_backslash = false) {
+	return translate::sentence(str_replace("\'", "'", $_content), $_name, $_backslash);
+}