From 7c0c180a56a42c4ca6ca8141e473055934ee1803 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Tue, 23 Jun 2020 20:57:09 +0200 Subject: [PATCH 1/2] Migrate WFE to new bootstrap mechanism Signed-off-by: Christoph Wurst --- apps/workflowengine/appinfo/app.php | 27 ----------- .../lib/AppInfo/Application.php | 45 +++++++++++++------ 2 files changed, 31 insertions(+), 41 deletions(-) delete mode 100644 apps/workflowengine/appinfo/app.php diff --git a/apps/workflowengine/appinfo/app.php b/apps/workflowengine/appinfo/app.php deleted file mode 100644 index 552d843260..0000000000 --- a/apps/workflowengine/appinfo/app.php +++ /dev/null @@ -1,27 +0,0 @@ - - * - * @license GNU AGPL version 3 or any later version - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see . - * - */ - -use \OCA\WorkflowEngine\AppInfo\Application; - -/** @var Application $application */ -$application = \OC::$server->query(Application::class); -$application->registerHooksAndListeners(); -$application->registerRuleListeners(); diff --git a/apps/workflowengine/lib/AppInfo/Application.php b/apps/workflowengine/lib/AppInfo/Application.php index 04922a7e9d..9d80861d54 100644 --- a/apps/workflowengine/lib/AppInfo/Application.php +++ b/apps/workflowengine/lib/AppInfo/Application.php @@ -26,37 +26,53 @@ use OCA\WorkflowEngine\Helper\LogContext; use OCA\WorkflowEngine\Manager; use OCA\WorkflowEngine\Service\Logger; use OCP\AppFramework\App; +use OCP\AppFramework\Bootstrap\IBootContext; +use OCP\AppFramework\Bootstrap\IBootstrap; +use OCP\AppFramework\Bootstrap\IRegistrationContext; use OCP\AppFramework\QueryException; use OCP\EventDispatcher\Event; use OCP\EventDispatcher\IEventDispatcher; +use OCP\ILogger; +use OCP\IServerContainer; use OCP\Template; use OCP\WorkflowEngine\IEntity; use OCP\WorkflowEngine\IEntityCompat; use OCP\WorkflowEngine\IOperation; use OCP\WorkflowEngine\IOperationCompat; -class Application extends App { +class Application extends App implements IBootstrap { public const APP_ID = 'workflowengine'; /** @var IEventDispatcher */ protected $dispatcher; + /** @var Manager */ protected $manager; public function __construct() { parent::__construct(self::APP_ID); + } - $this->getContainer()->registerAlias('RequestTimeController', RequestTime::class); + public function register(IRegistrationContext $context): void { + $context->registerServiceAlias('RequestTimeController', RequestTime::class); + } - $this->dispatcher = $this->getContainer()->getServer()->query(IEventDispatcher::class); - $this->manager = $this->getContainer()->query(Manager::class); + public function boot(IBootContext $context): void { + $this->registerHooksAndListeners( + $context->getAppContainer()->query(IEventDispatcher::class) + ); + $this->registerRuleListeners( + $context->getAppContainer()->query(IEventDispatcher::class), + $context->getServerContainer(), + $context->getAppContainer()->query(ILogger::class) + ); } /** * Register all hooks and listeners */ - public function registerHooksAndListeners() { - $this->dispatcher->addListener( + private function registerHooksAndListeners(IEventDispatcher $dispatcher): void { + $dispatcher->addListener( 'OCP\WorkflowEngine::loadAdditionalSettingScripts', function () { if (!function_exists('style')) { @@ -78,21 +94,23 @@ class Application extends App { ); } - public function registerRuleListeners() { + private function registerRuleListeners(IEventDispatcher $dispatcher, + IServerContainer $container, + ILogger $logger): void { $configuredEvents = $this->manager->getAllConfiguredEvents(); foreach ($configuredEvents as $operationClass => $events) { foreach ($events as $entityClass => $eventNames) { - array_map(function (string $eventName) use ($operationClass, $entityClass) { - $this->dispatcher->addListener( + array_map(function (string $eventName) use ($container, $dispatcher, $logger, $operationClass, $entityClass) { + $dispatcher->addListener( $eventName, - function ($event) use ($eventName, $operationClass, $entityClass) { + function ($event) use ($container, $eventName, $logger, $operationClass, $entityClass) { $ruleMatcher = $this->manager->getRuleMatcher(); try { /** @var IEntity $entity */ - $entity = $this->getContainer()->query($entityClass); + $entity = $container->query($entityClass); /** @var IOperation $operation */ - $operation = $this->getContainer()->query($operationClass); + $operation = $container->query($operationClass); $ruleMatcher->setEntity($entity); $ruleMatcher->setOperation($operation); @@ -104,7 +122,7 @@ class Application extends App { ->setEventName($eventName); /** @var Logger $flowLogger */ - $flowLogger = $this->getContainer()->query(Logger::class); + $flowLogger = $container->query(Logger::class); $flowLogger->logEventInit($ctx); if ($event instanceof Event) { @@ -115,7 +133,6 @@ class Application extends App { $entity->prepareRuleMatcherCompat($ruleMatcher, $eventName, $event); $operation->onEventCompat($eventName, $event, $ruleMatcher); } else { - $logger = $this->getContainer()->getServer()->getLogger(); $logger->debug( 'Cannot handle event {name} of {event} against entity {entity} and operation {operation}', [ From 1428853c8665562b2af2e43d17a8cdc5b616353d Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Tue, 23 Jun 2020 21:09:09 +0200 Subject: [PATCH 2/2] Move the event listener into a dedicated class Signed-off-by: Christoph Wurst --- .../composer/composer/autoload_classmap.php | 1 + .../composer/composer/autoload_static.php | 1 + .../lib/AppInfo/Application.php | 51 ++++-------------- .../LoadAdditionalSettingsScriptsListener.php | 53 +++++++++++++++++++ 4 files changed, 66 insertions(+), 40 deletions(-) create mode 100644 apps/workflowengine/lib/Listener/LoadAdditionalSettingsScriptsListener.php diff --git a/apps/workflowengine/composer/composer/autoload_classmap.php b/apps/workflowengine/composer/composer/autoload_classmap.php index bcbc9af457..cb2f383729 100644 --- a/apps/workflowengine/composer/composer/autoload_classmap.php +++ b/apps/workflowengine/composer/composer/autoload_classmap.php @@ -27,6 +27,7 @@ return array( 'OCA\\WorkflowEngine\\Entity\\File' => $baseDir . '/../lib/Entity/File.php', 'OCA\\WorkflowEngine\\Helper\\LogContext' => $baseDir . '/../lib/Helper/LogContext.php', 'OCA\\WorkflowEngine\\Helper\\ScopeContext' => $baseDir . '/../lib/Helper/ScopeContext.php', + 'OCA\\WorkflowEngine\\Listener\\LoadAdditionalSettingsScriptsListener' => $baseDir . '/../lib/Listener/LoadAdditionalSettingsScriptsListener.php', 'OCA\\WorkflowEngine\\Manager' => $baseDir . '/../lib/Manager.php', 'OCA\\WorkflowEngine\\Migration\\PopulateNewlyIntroducedDatabaseFields' => $baseDir . '/../lib/Migration/PopulateNewlyIntroducedDatabaseFields.php', 'OCA\\WorkflowEngine\\Migration\\Version2000Date20190808074233' => $baseDir . '/../lib/Migration/Version2000Date20190808074233.php', diff --git a/apps/workflowengine/composer/composer/autoload_static.php b/apps/workflowengine/composer/composer/autoload_static.php index 98853a837d..c5bc8e28ba 100644 --- a/apps/workflowengine/composer/composer/autoload_static.php +++ b/apps/workflowengine/composer/composer/autoload_static.php @@ -42,6 +42,7 @@ class ComposerStaticInitWorkflowEngine 'OCA\\WorkflowEngine\\Entity\\File' => __DIR__ . '/..' . '/../lib/Entity/File.php', 'OCA\\WorkflowEngine\\Helper\\LogContext' => __DIR__ . '/..' . '/../lib/Helper/LogContext.php', 'OCA\\WorkflowEngine\\Helper\\ScopeContext' => __DIR__ . '/..' . '/../lib/Helper/ScopeContext.php', + 'OCA\\WorkflowEngine\\Listener\\LoadAdditionalSettingsScriptsListener' => __DIR__ . '/..' . '/../lib/Listener/LoadAdditionalSettingsScriptsListener.php', 'OCA\\WorkflowEngine\\Manager' => __DIR__ . '/..' . '/../lib/Manager.php', 'OCA\\WorkflowEngine\\Migration\\PopulateNewlyIntroducedDatabaseFields' => __DIR__ . '/..' . '/../lib/Migration/PopulateNewlyIntroducedDatabaseFields.php', 'OCA\\WorkflowEngine\\Migration\\Version2000Date20190808074233' => __DIR__ . '/..' . '/../lib/Migration/Version2000Date20190808074233.php', diff --git a/apps/workflowengine/lib/AppInfo/Application.php b/apps/workflowengine/lib/AppInfo/Application.php index 9d80861d54..2fd38c5f1b 100644 --- a/apps/workflowengine/lib/AppInfo/Application.php +++ b/apps/workflowengine/lib/AppInfo/Application.php @@ -23,6 +23,7 @@ namespace OCA\WorkflowEngine\AppInfo; use OCA\WorkflowEngine\Controller\RequestTime; use OCA\WorkflowEngine\Helper\LogContext; +use OCA\WorkflowEngine\Listener\LoadAdditionalSettingsScriptsListener; use OCA\WorkflowEngine\Manager; use OCA\WorkflowEngine\Service\Logger; use OCP\AppFramework\App; @@ -34,7 +35,6 @@ use OCP\EventDispatcher\Event; use OCP\EventDispatcher\IEventDispatcher; use OCP\ILogger; use OCP\IServerContainer; -use OCP\Template; use OCP\WorkflowEngine\IEntity; use OCP\WorkflowEngine\IEntityCompat; use OCP\WorkflowEngine\IOperation; @@ -43,24 +43,20 @@ use OCP\WorkflowEngine\IOperationCompat; class Application extends App implements IBootstrap { public const APP_ID = 'workflowengine'; - /** @var IEventDispatcher */ - protected $dispatcher; - - /** @var Manager */ - protected $manager; - public function __construct() { parent::__construct(self::APP_ID); } public function register(IRegistrationContext $context): void { $context->registerServiceAlias('RequestTimeController', RequestTime::class); + $context->registerEventListener( + 'OCP\WorkflowEngine::loadAdditionalSettingScripts', + LoadAdditionalSettingsScriptsListener::class, + -100 + ); } public function boot(IBootContext $context): void { - $this->registerHooksAndListeners( - $context->getAppContainer()->query(IEventDispatcher::class) - ); $this->registerRuleListeners( $context->getAppContainer()->query(IEventDispatcher::class), $context->getServerContainer(), @@ -68,44 +64,19 @@ class Application extends App implements IBootstrap { ); } - /** - * Register all hooks and listeners - */ - private function registerHooksAndListeners(IEventDispatcher $dispatcher): void { - $dispatcher->addListener( - 'OCP\WorkflowEngine::loadAdditionalSettingScripts', - function () { - if (!function_exists('style')) { - // This is hacky, but we need to load the template class - class_exists(Template::class, true); - } - - script('core', [ - 'files/fileinfo', - 'files/client', - 'dist/systemtags', - ]); - - script(self::APP_ID, [ - 'workflowengine', - ]); - }, - -100 - ); - } - private function registerRuleListeners(IEventDispatcher $dispatcher, IServerContainer $container, ILogger $logger): void { - $configuredEvents = $this->manager->getAllConfiguredEvents(); + $manager = $container->query(Manager::class); + $configuredEvents = $manager->getAllConfiguredEvents(); foreach ($configuredEvents as $operationClass => $events) { foreach ($events as $entityClass => $eventNames) { - array_map(function (string $eventName) use ($container, $dispatcher, $logger, $operationClass, $entityClass) { + array_map(function (string $eventName) use ($manager, $container, $dispatcher, $logger, $operationClass, $entityClass) { $dispatcher->addListener( $eventName, - function ($event) use ($container, $eventName, $logger, $operationClass, $entityClass) { - $ruleMatcher = $this->manager->getRuleMatcher(); + function ($event) use ($manager, $container, $eventName, $logger, $operationClass, $entityClass) { + $ruleMatcher = $manager->getRuleMatcher(); try { /** @var IEntity $entity */ $entity = $container->query($entityClass); diff --git a/apps/workflowengine/lib/Listener/LoadAdditionalSettingsScriptsListener.php b/apps/workflowengine/lib/Listener/LoadAdditionalSettingsScriptsListener.php new file mode 100644 index 0000000000..55ab70ef29 --- /dev/null +++ b/apps/workflowengine/lib/Listener/LoadAdditionalSettingsScriptsListener.php @@ -0,0 +1,53 @@ + + * + * @author 2020 Christoph Wurst + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +namespace OCA\WorkflowEngine\Listener; + +use OCA\WorkflowEngine\AppInfo\Application; +use OCP\EventDispatcher\Event; +use OCP\EventDispatcher\IEventListener; +use OCP\Template; +use function class_exists; +use function function_exists; +use function script; + +class LoadAdditionalSettingsScriptsListener implements IEventListener { + public function handle(Event $event): void { + if (!function_exists('style')) { + // This is hacky, but we need to load the template class + class_exists(Template::class, true); + } + + script('core', [ + 'files/fileinfo', + 'files/client', + 'dist/systemtags', + ]); + + script(Application::APP_ID, [ + 'workflowengine', + ]); + } +}