N°4756 - Event service initialization

2026-02-13 07:24:13 +01:00 · 2022-11-16 21:03:01 +01:00
parent 363a1507cf
commit 6585f717c5
16 changed files with 124 additions and 44 deletions
--- a/application/applicationevents.class.inc.php
+++ b/application/applicationevents.class.inc.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * @copyright   Copyright (C) 2010-2022 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+use Combodo\iTop\Service\EventService;
+use Combodo\iTop\Service\iEventEnrolment;
+
+class ApplicationEvents implements iEventEnrolment
+{
+	// Startup events
+	const APPLICATION_EVENT_REQUEST_RECEIVED = 'APPLICATION_EVENT_REQUEST_RECEIVED';
+	const APPLICATION_EVENT_METAMODEL_STARTED = 'APPLICATION_EVENT_METAMODEL_STARTED';
+
+	/**
+	 * @inheritDoc
+	 */
+	public function InitEvents()
+	{
+		EventService::RegisterEvent(self::APPLICATION_EVENT_REQUEST_RECEIVED, [
+			'description' => 'A request was received from the network, at this point only the session is started, the configuration is not even loaded',
+		], 'application');
+		EventService::RegisterEvent(self::APPLICATION_EVENT_METAMODEL_STARTED, [
+			'description' => 'The MetaModel is fully started',
+		], 'application');
+	}
+}
--- a/application/startup.inc.php
+++ b/application/startup.inc.php
@@ -16,6 +16,8 @@
 //   You should have received a copy of the GNU Affero General Public License
 //   along with iTop. If not, see <http://www.gnu.org/licenses/>
 use Combodo\iTop\Application\Helper\Session;
+use Combodo\iTop\Service\EventData;
+use Combodo\iTop\Service\EventService;

 require_once(APPROOT.'/core/cmdbobject.class.inc.php');
 require_once(APPROOT.'/application/utils.inc.php');
@@ -68,6 +70,9 @@ $oKPI = new ExecutionKPI();
 Session::Start();
 $oKPI->ComputeAndReport("Session Start");

+EventService::InitService();
+EventService::FireEvent(new EventData(ApplicationEvents::APPLICATION_EVENT_REQUEST_RECEIVED));
+
 $sSwitchEnv = utils::ReadParam('switch_env', null);
 $bAllowCache = true;
 if (($sSwitchEnv != null) && file_exists(APPCONF.$sSwitchEnv.'/'.ITOP_CONFIG_FILE) &&( Session::Get('itop_env') !== $sSwitchEnv))
@@ -99,3 +104,4 @@ else
 }
 $sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE;
 MetaModel::Startup($sConfigFile, false /* $bModelOnly */, $bAllowCache, false /* $bTraceSourceFiles */, $sEnv);
+EventService::FireEvent(new EventData(ApplicationEvents::APPLICATION_EVENT_METAMODEL_STARTED));
--- a/application/utils.inc.php
+++ b/application/utils.inc.php
@@ -2698,7 +2698,7 @@ HTML;
 	 * @return array
 	 * @since 3.0.0
 	 */
-	public static function GetClassesForInterface(string $sInterface, string $sClassNameFilter = '', $aExcludedPath = []): array
+	public static function GetClassesForInterface(string $sInterface, string $sClassNameFilter = '', $aExcludedPath = ['[\\\\/]lib[\\\\/]', '[\\\\/]node_modules[\\\\/]', '[\\\\/]test[\\\\/]']): array
 	{
 		$aMatchingClasses = [];

--- a/core/dbobject.class.php
+++ b/core/dbobject.class.php
@@ -181,7 +181,7 @@ abstract class DBObject implements iDisplay
 			$this->m_aTouchedAtt = array();
 			$this->m_aModifiedAtt = array();
 			$this->m_sObjectUniqId = get_class($this).'::'.$this->GetKey().'_'.utils::GetUniqId();
-			$this->RegisterEvents();
+			$this->RegisterEventListeners();
 			return;
 		}
 		// Creation of a brand new object
@@ -204,10 +204,10 @@ abstract class DBObject implements iDisplay
 		$this->UpdateMetaAttributes();

 		$this->m_sObjectUniqId = get_class($this).'::0'.'_'.utils::GetUniqId();
-		$this->RegisterEvents();
+		$this->RegisterEventListeners();
 	}

-	protected function RegisterEvents()
+	protected function RegisterEventListeners()
 	{
 	}

--- a/lib/autoload.php
+++ b/lib/autoload.php
@@ -2,11 +2,6 @@

 // autoload.php @generated by Composer

-if (PHP_VERSION_ID < 50600) {
-    echo 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
-    exit(1);
-}
-
 require_once __DIR__ . '/composer/autoload_real.php';

 return ComposerAutoloaderInit7f81b4a2a468a061c306af5e447a9a9f::getLoader();
--- a/lib/composer/ClassLoader.php
+++ b/lib/composer/ClassLoader.php
@@ -149,7 +149,7 @@ class ClassLoader

    /**
     * @return string[] Array of classname => path
-     * @psalm-return array<string, string>
+     * @psalm-var array<string, string>
     */
    public function getClassMap()
    {
--- a/lib/composer/autoload_classmap.php
+++ b/lib/composer/autoload_classmap.php
@@ -2,7 +2,7 @@

 // autoload_classmap.php @generated by Composer

-$vendorDir = dirname(__DIR__);
+$vendorDir = dirname(dirname(__FILE__));
 $baseDir = dirname($vendorDir);

 return array(
@@ -21,6 +21,7 @@ return array(
    'AjaxPage' => $baseDir . '/sources/Application/WebPage/AjaxPage.php',
    'ApcService' => $baseDir . '/core/apc-service.class.inc.php',
    'ApplicationContext' => $baseDir . '/application/applicationcontext.class.inc.php',
+    'ApplicationEvents' => $baseDir . '/application/applicationevents.class.inc.php',
    'ApplicationException' => $baseDir . '/application/exceptions/ApplicationException.php',
    'ApplicationMenu' => $baseDir . '/application/menunode.class.inc.php',
    'ApplicationPopupMenuItem' => $baseDir . '/application/applicationextension.inc.php',
@@ -416,6 +417,7 @@ return array(
    'Combodo\\iTop\\Service\\EventData' => $baseDir . '/sources/Application/Service/EventData.php',
    'Combodo\\iTop\\Service\\EventHelper' => $baseDir . '/sources/Application/Service/EventHelper.php',
    'Combodo\\iTop\\Service\\EventService' => $baseDir . '/sources/Application/Service/EventService.php',
+    'Combodo\\iTop\\Service\\iEventEnrolment' => $baseDir . '/sources/Application/Service/iEventEnrolment.php',
    'CompileCSSService' => $baseDir . '/application/compilecssservice.class.inc.php',
    'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php',
    'Config' => $baseDir . '/core/config.class.inc.php',
--- a/lib/composer/autoload_files.php
+++ b/lib/composer/autoload_files.php
@@ -2,24 +2,24 @@

 // autoload_files.php @generated by Composer

-$vendorDir = dirname(__DIR__);
+$vendorDir = dirname(dirname(__FILE__));
 $baseDir = dirname($vendorDir);

 return array(
-    'a4a119a56e50fbb293281d9a48007e0e' => $vendorDir . '/symfony/polyfill-php80/bootstrap.php',
    '6e3fae29631ef280660b3cdad06f25a8' => $vendorDir . '/symfony/deprecation-contracts/function.php',
+    'a4a119a56e50fbb293281d9a48007e0e' => $vendorDir . '/symfony/polyfill-php80/bootstrap.php',
    '0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => $vendorDir . '/symfony/polyfill-mbstring/bootstrap.php',
    '320cde22f66dd4f5d3fd621d3e88b98f' => $vendorDir . '/symfony/polyfill-ctype/bootstrap.php',
-    '23c18046f52bef3eea034657bafda50f' => $vendorDir . '/symfony/polyfill-php81/bootstrap.php',
    '0d59ee240a4cd96ddbb4ff164fccea4d' => $vendorDir . '/symfony/polyfill-php73/bootstrap.php',
+    '23c18046f52bef3eea034657bafda50f' => $vendorDir . '/symfony/polyfill-php81/bootstrap.php',
    '667aeda72477189d0494fecd327c3641' => $vendorDir . '/symfony/var-dumper/Resources/functions/dump.php',
-    '7b11c4dc42b3b3023073cb14e519683c' => $vendorDir . '/ralouphie/getallheaders/src/getallheaders.php',
-    'c964ee0ededf28c96ebd9db5099ef910' => $vendorDir . '/guzzlehttp/promises/src/functions_include.php',
    'e69f7f6ee287b969198c3c9d6777bd38' => $vendorDir . '/symfony/polyfill-intl-normalizer/bootstrap.php',
-    '37a3dc5111fe8f707ab4c132ef1dbc62' => $vendorDir . '/guzzlehttp/guzzle/src/functions_include.php',
    'c9d07b32a2e02bc0fc582d4f0c1b56cc' => $vendorDir . '/laminas/laminas-servicemanager/src/autoload.php',
+    '7b11c4dc42b3b3023073cb14e519683c' => $vendorDir . '/ralouphie/getallheaders/src/getallheaders.php',
    '8825ede83f2f289127722d4e842cf7e8' => $vendorDir . '/symfony/polyfill-intl-grapheme/bootstrap.php',
+    'c964ee0ededf28c96ebd9db5099ef910' => $vendorDir . '/guzzlehttp/promises/src/functions_include.php',
+    'b6b991a57620e2fb6b2f66f03fe9ddc2' => $vendorDir . '/symfony/string/Resources/functions.php',
+    '37a3dc5111fe8f707ab4c132ef1dbc62' => $vendorDir . '/guzzlehttp/guzzle/src/functions_include.php',
    '25072dd6e2470089de65ae7bf11d3109' => $vendorDir . '/symfony/polyfill-php72/bootstrap.php',
    'f598d06aa772fa33d905e87be6398fb1' => $vendorDir . '/symfony/polyfill-intl-idn/bootstrap.php',
-    'b6b991a57620e2fb6b2f66f03fe9ddc2' => $vendorDir . '/symfony/string/Resources/functions.php',
 );
--- a/lib/composer/autoload_namespaces.php
+++ b/lib/composer/autoload_namespaces.php
@@ -2,7 +2,7 @@

 // autoload_namespaces.php @generated by Composer

-$vendorDir = dirname(__DIR__);
+$vendorDir = dirname(dirname(__FILE__));
 $baseDir = dirname($vendorDir);

 return array(
--- a/lib/composer/autoload_psr4.php
+++ b/lib/composer/autoload_psr4.php
@@ -2,7 +2,7 @@

 // autoload_psr4.php @generated by Composer

-$vendorDir = dirname(__DIR__);
+$vendorDir = dirname(dirname(__FILE__));
 $baseDir = dirname($vendorDir);

 return array(
--- a/lib/composer/autoload_real.php
+++ b/lib/composer/autoload_real.php
@@ -25,20 +25,33 @@ class ComposerAutoloaderInit7f81b4a2a468a061c306af5e447a9a9f
        require __DIR__ . '/platform_check.php';

        spl_autoload_register(array('ComposerAutoloaderInit7f81b4a2a468a061c306af5e447a9a9f', 'loadClassLoader'), true, true);
-        self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
+        self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(\dirname(__FILE__)));
        spl_autoload_unregister(array('ComposerAutoloaderInit7f81b4a2a468a061c306af5e447a9a9f', 'loadClassLoader'));

        $includePaths = require __DIR__ . '/include_paths.php';
        $includePaths[] = get_include_path();
        set_include_path(implode(PATH_SEPARATOR, $includePaths));

-        require __DIR__ . '/autoload_static.php';
-        call_user_func(\Composer\Autoload\ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f::getInitializer($loader));
+        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
+        if ($useStaticLoader) {
+            require __DIR__ . '/autoload_static.php';
+
+            call_user_func(\Composer\Autoload\ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f::getInitializer($loader));
+        } else {
+            $classMap = require __DIR__ . '/autoload_classmap.php';
+            if ($classMap) {
+                $loader->addClassMap($classMap);
+            }
+        }

        $loader->setClassMapAuthoritative(true);
        $loader->register(true);

-        $includeFiles = \Composer\Autoload\ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f::$files;
+        if ($useStaticLoader) {
+            $includeFiles = Composer\Autoload\ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f::$files;
+        } else {
+            $includeFiles = require __DIR__ . '/autoload_files.php';
+        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequire7f81b4a2a468a061c306af5e447a9a9f($fileIdentifier, $file);
        }
@@ -47,16 +60,11 @@ class ComposerAutoloaderInit7f81b4a2a468a061c306af5e447a9a9f
    }
 }

-/**
- * @param string $fileIdentifier
- * @param string $file
- * @return void
- */
 function composerRequire7f81b4a2a468a061c306af5e447a9a9f($fileIdentifier, $file)
 {
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
-        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
-
        require $file;
+
+        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
    }
 }
--- a/lib/composer/autoload_static.php
+++ b/lib/composer/autoload_static.php
@@ -7,22 +7,22 @@ namespace Composer\Autoload;
 class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
 {
    public static $files = array (
-        'a4a119a56e50fbb293281d9a48007e0e' => __DIR__ . '/..' . '/symfony/polyfill-php80/bootstrap.php',
        '6e3fae29631ef280660b3cdad06f25a8' => __DIR__ . '/..' . '/symfony/deprecation-contracts/function.php',
+        'a4a119a56e50fbb293281d9a48007e0e' => __DIR__ . '/..' . '/symfony/polyfill-php80/bootstrap.php',
        '0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => __DIR__ . '/..' . '/symfony/polyfill-mbstring/bootstrap.php',
        '320cde22f66dd4f5d3fd621d3e88b98f' => __DIR__ . '/..' . '/symfony/polyfill-ctype/bootstrap.php',
-        '23c18046f52bef3eea034657bafda50f' => __DIR__ . '/..' . '/symfony/polyfill-php81/bootstrap.php',
        '0d59ee240a4cd96ddbb4ff164fccea4d' => __DIR__ . '/..' . '/symfony/polyfill-php73/bootstrap.php',
+        '23c18046f52bef3eea034657bafda50f' => __DIR__ . '/..' . '/symfony/polyfill-php81/bootstrap.php',
        '667aeda72477189d0494fecd327c3641' => __DIR__ . '/..' . '/symfony/var-dumper/Resources/functions/dump.php',
-        '7b11c4dc42b3b3023073cb14e519683c' => __DIR__ . '/..' . '/ralouphie/getallheaders/src/getallheaders.php',
-        'c964ee0ededf28c96ebd9db5099ef910' => __DIR__ . '/..' . '/guzzlehttp/promises/src/functions_include.php',
        'e69f7f6ee287b969198c3c9d6777bd38' => __DIR__ . '/..' . '/symfony/polyfill-intl-normalizer/bootstrap.php',
-        '37a3dc5111fe8f707ab4c132ef1dbc62' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/functions_include.php',
        'c9d07b32a2e02bc0fc582d4f0c1b56cc' => __DIR__ . '/..' . '/laminas/laminas-servicemanager/src/autoload.php',
+        '7b11c4dc42b3b3023073cb14e519683c' => __DIR__ . '/..' . '/ralouphie/getallheaders/src/getallheaders.php',
        '8825ede83f2f289127722d4e842cf7e8' => __DIR__ . '/..' . '/symfony/polyfill-intl-grapheme/bootstrap.php',
+        'c964ee0ededf28c96ebd9db5099ef910' => __DIR__ . '/..' . '/guzzlehttp/promises/src/functions_include.php',
+        'b6b991a57620e2fb6b2f66f03fe9ddc2' => __DIR__ . '/..' . '/symfony/string/Resources/functions.php',
+        '37a3dc5111fe8f707ab4c132ef1dbc62' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/functions_include.php',
        '25072dd6e2470089de65ae7bf11d3109' => __DIR__ . '/..' . '/symfony/polyfill-php72/bootstrap.php',
        'f598d06aa772fa33d905e87be6398fb1' => __DIR__ . '/..' . '/symfony/polyfill-intl-idn/bootstrap.php',
-        'b6b991a57620e2fb6b2f66f03fe9ddc2' => __DIR__ . '/..' . '/symfony/string/Resources/functions.php',
    );

    public static $prefixLengthsPsr4 = array (
@@ -386,6 +386,7 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
        'AjaxPage' => __DIR__ . '/../..' . '/sources/Application/WebPage/AjaxPage.php',
        'ApcService' => __DIR__ . '/../..' . '/core/apc-service.class.inc.php',
        'ApplicationContext' => __DIR__ . '/../..' . '/application/applicationcontext.class.inc.php',
+        'ApplicationEvents' => __DIR__ . '/../..' . '/application/applicationevents.class.inc.php',
        'ApplicationException' => __DIR__ . '/../..' . '/application/exceptions/ApplicationException.php',
        'ApplicationMenu' => __DIR__ . '/../..' . '/application/menunode.class.inc.php',
        'ApplicationPopupMenuItem' => __DIR__ . '/../..' . '/application/applicationextension.inc.php',
@@ -781,6 +782,7 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
        'Combodo\\iTop\\Service\\EventData' => __DIR__ . '/../..' . '/sources/Application/Service/EventData.php',
        'Combodo\\iTop\\Service\\EventHelper' => __DIR__ . '/../..' . '/sources/Application/Service/EventHelper.php',
        'Combodo\\iTop\\Service\\EventService' => __DIR__ . '/../..' . '/sources/Application/Service/EventService.php',
+        'Combodo\\iTop\\Service\\iEventEnrolment' => __DIR__ . '/../..' . '/sources/Application/Service/iEventEnrolment.php',
        'CompileCSSService' => __DIR__ . '/../..' . '/application/compilecssservice.class.inc.php',
        'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php',
        'Config' => __DIR__ . '/../..' . '/core/config.class.inc.php',
--- a/lib/composer/include_paths.php
+++ b/lib/composer/include_paths.php
@@ -2,7 +2,7 @@

 // include_paths.php @generated by Composer

-$vendorDir = dirname(__DIR__);
+$vendorDir = dirname(dirname(__FILE__));
 $baseDir = dirname($vendorDir);

 return array(
--- a/setup/compiler.class.inc.php
+++ b/setup/compiler.class.inc.php
@@ -1343,9 +1343,9 @@ EOF
 		if (!empty($sEvents))
 		{
 			$sMethods .= <<<EOF
-	protected function RegisterEvents()
+	protected function RegisterEventListeners()
 	{
-		parent::RegisterEvents();
+		parent::RegisterEventListeners();
 $sEvents
 	}

--- a/sources/Application/Service/EventService.php
+++ b/sources/Application/Service/EventService.php
@@ -12,12 +12,28 @@ use CoreException;
 use Exception;
 use ExecutionKPI;
 use ReflectionClass;
+use utils;

 class EventService
 {
-	public static $aEventListeners = [];
-	private static $iEventIdCounter = 0;
-	private static $aEventDescription = [];
+	public static $aEventListeners;
+	private static $iEventIdCounter;
+	private static $aEventDescription;
+
+	public static function InitService()
+	{
+		self::$aEventListeners = [];
+		self::$iEventIdCounter = 0;
+		self::$aEventDescription = [];
+
+		$aEventEnrolments = utils::GetClassesForInterface(iEventEnrolment::class);
+		foreach ($aEventEnrolments as $sEventEnrolmentClass) {
+			/** @var \Combodo\iTop\Service\iEventEnrolment $oEventEnrolment */
+			$oEventEnrolment = new $sEventEnrolmentClass();
+			$oEventEnrolment->InitEvents();
+		}
+
+	}

 	/**
 	 * Register a callback for a specific event
@@ -242,7 +258,13 @@ class EventService
 		return false;
 	}

-	// For information only
+	/**
+	 * @param string $sEvent
+	 * @param array $aDescription
+	 * @param string $sModule
+	 *
+	 * @return void
+	 */
 	public static function RegisterEvent(string $sEvent, array $aDescription, string $sModule)
 	{
 		if (isset(self::$aEventDescription[$sEvent])) {
--- a/sources/Application/Service/iEventEnrolment.php
+++ b/sources/Application/Service/iEventEnrolment.php
@@ -0,0 +1,16 @@
+<?php
+/*
+ * @copyright   Copyright (C) 2010-2022 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Service;
+
+interface iEventEnrolment
+{
+	/**
+	 * Extension point to register the events and events listeners
+	 * @return void
+	 */
+	public function InitEvents();
+}