Merge pull request #21547 from nextcloud/enhancement/workflowengine-bootstrap

Migrate WFE to the new bootstrap mechanism

apps/workflowengine/appinfo/app.php

@@ -1,27 +0,0 @@
-<?php
-/**
- * @copyright Copyright (c) 2016 Morris Jobke <hey@morrisjobke.de>
- *
- * @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 <http://www.gnu.org/licenses/>.
- *
- */
-
-use \OCA\WorkflowEngine\AppInfo\Application;
-
-/** @var Application $application */
-$application = \OC::$server->query(Application::class);
-$application->registerHooksAndListeners();
-$application->registerRuleListeners();

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',

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',

apps/workflowengine/lib/AppInfo/Application.php

@@ -23,76 +23,65 @@ 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;
+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\Template;
+use OCP\ILogger;
+use OCP\IServerContainer;
 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);
-
-		$this->dispatcher = $this->getContainer()->getServer()->query(IEventDispatcher::class);
-		$this->manager = $this->getContainer()->query(Manager::class);
 	}
 
-	/**
-	 * Register all hooks and listeners
-	 */
-	public function registerHooksAndListeners() {
-		$this->dispatcher->addListener(
+	public function register(IRegistrationContext $context): void {
+		$context->registerServiceAlias('RequestTimeController', RequestTime::class);
+		$context->registerEventListener(
 			'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',
-				]);
-			},
+			LoadAdditionalSettingsScriptsListener::class,
 			-100
 		);
 	}
 
-	public function registerRuleListeners() {
-		$configuredEvents = $this->manager->getAllConfiguredEvents();
+	public function boot(IBootContext $context): void {
+		$this->registerRuleListeners(
+			$context->getAppContainer()->query(IEventDispatcher::class),
+			$context->getServerContainer(),
+			$context->getAppContainer()->query(ILogger::class)
+		);
+	}
+
+	private function registerRuleListeners(IEventDispatcher $dispatcher,
+										   IServerContainer $container,
+										   ILogger $logger): void {
+		$manager = $container->query(Manager::class);
+		$configuredEvents = $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 ($manager, $container, $dispatcher, $logger, $operationClass, $entityClass) {
+					$dispatcher->addListener(
 						$eventName,
-						function ($event) use ($eventName, $operationClass, $entityClass) {
-							$ruleMatcher = $this->manager->getRuleMatcher();
+						function ($event) use ($manager, $container, $eventName, $logger, $operationClass, $entityClass) {
+							$ruleMatcher = $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 +93,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 +104,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}',
 										[

apps/workflowengine/lib/Listener/LoadAdditionalSettingsScriptsListener.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+
+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',
+		]);
+	}
+}