diff options
Diffstat (limited to 'lib/private/AppFramework/Bootstrap/Coordinator.php')
-rw-r--r-- | lib/private/AppFramework/Bootstrap/Coordinator.php | 160 |
1 files changed, 77 insertions, 83 deletions
diff --git a/lib/private/AppFramework/Bootstrap/Coordinator.php b/lib/private/AppFramework/Bootstrap/Coordinator.php index 06a17e5242b..a31dd6a05e1 100644 --- a/lib/private/AppFramework/Bootstrap/Coordinator.php +++ b/lib/private/AppFramework/Bootstrap/Coordinator.php @@ -3,83 +3,56 @@ declare(strict_types=1); /** - * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Julius Härtl <jus@bitgrid.net> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Robin Appelman <robin@icewind.nl> - * - * @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/>. - * + * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ namespace OC\AppFramework\Bootstrap; use OC\Support\CrashReport\Registry; use OC_App; +use OCP\App\AppPathNotFoundException; +use OCP\App\IAppManager; use OCP\AppFramework\App; use OCP\AppFramework\Bootstrap\IBootstrap; use OCP\AppFramework\QueryException; use OCP\Dashboard\IManager; +use OCP\Diagnostics\IEventLogger; use OCP\EventDispatcher\IEventDispatcher; -use OCP\ILogger; use OCP\IServerContainer; +use Psr\Container\ContainerExceptionInterface; +use Psr\Log\LoggerInterface; use Throwable; use function class_exists; use function class_implements; use function in_array; class Coordinator { - - /** @var IServerContainer */ - private $serverContainer; - - /** @var Registry */ - private $registry; - - /** @var IManager */ - private $dashboardManager; - - /** @var IEventDispatcher */ - private $eventDispatcher; - - /** @var ILogger */ - private $logger; - /** @var RegistrationContext|null */ private $registrationContext; - /** @var string[] */ - private $bootedApps = []; - - public function __construct(IServerContainer $container, - Registry $registry, - IManager $dashboardManager, - IEventDispatcher $eventListener, - ILogger $logger) { - $this->serverContainer = $container; - $this->registry = $registry; - $this->dashboardManager = $dashboardManager; - $this->eventDispatcher = $eventListener; - $this->logger = $logger; + /** @var array<string,true> */ + private array $bootedApps = []; + + public function __construct( + private IServerContainer $serverContainer, + private Registry $registry, + private IManager $dashboardManager, + private IEventDispatcher $eventDispatcher, + private IEventLogger $eventLogger, + private IAppManager $appManager, + private LoggerInterface $logger, + ) { } public function runInitialRegistration(): void { - $this->registerApps(OC_App::getEnabledApps()); + $apps = OC_App::getEnabledApps(); + if (!empty($apps)) { + // make sure to also register the core app + $apps = ['core', ...$apps]; + } + + $this->registerApps($apps); } public function runLazyRegistration(string $appId): void { @@ -90,58 +63,78 @@ class Coordinator { * @param string[] $appIds */ private function registerApps(array $appIds): void { + $this->eventLogger->start('bootstrap:register_apps', ''); if ($this->registrationContext === null) { $this->registrationContext = new RegistrationContext($this->logger); } $apps = []; foreach ($appIds as $appId) { + $this->eventLogger->start("bootstrap:register_app:$appId", "Register $appId"); + $this->eventLogger->start("bootstrap:register_app:$appId:autoloader", "Setup autoloader for $appId"); /* * First, we have to enable the app's autoloader - * - * @todo use $this->appManager->getAppPath($appId) here */ - $path = OC_App::getAppPath($appId); - if ($path === false) { + try { + $path = $this->appManager->getAppPath($appId); + OC_App::registerAutoloading($appId, $path); + } catch (AppPathNotFoundException) { // Ignore continue; } - OC_App::registerAutoloading($appId, $path); + $this->eventLogger->end("bootstrap:register_app:$appId:autoloader"); /* - * Next we check if there is an application class and it implements + * Next we check if there is an application class, and it implements * the \OCP\AppFramework\Bootstrap\IBootstrap interface */ - $appNameSpace = App::buildAppNamespace($appId); + if ($appId === 'core') { + $appNameSpace = 'OC\\Core'; + } else { + $appNameSpace = App::buildAppNamespace($appId); + } $applicationClassName = $appNameSpace . '\\AppInfo\\Application'; - if (class_exists($applicationClassName) && in_array(IBootstrap::class, class_implements($applicationClassName), true)) { - try { - /** @var IBootstrap|App $application */ - $apps[$appId] = $application = $this->serverContainer->query($applicationClassName); - } catch (QueryException $e) { - // Weird, but ok - continue; - } - try { + + try { + if (class_exists($applicationClassName) && is_a($applicationClassName, IBootstrap::class, true)) { + $this->eventLogger->start("bootstrap:register_app:$appId:application", "Load `Application` instance for $appId"); + try { + /** @var IBootstrap&App $application */ + $application = $this->serverContainer->query($applicationClassName); + $apps[$appId] = $application; + } catch (ContainerExceptionInterface $e) { + // Weird, but ok + $this->eventLogger->end("bootstrap:register_app:$appId"); + continue; + } + $this->eventLogger->end("bootstrap:register_app:$appId:application"); + + $this->eventLogger->start("bootstrap:register_app:$appId:register", "`Application::register` for $appId"); $application->register($this->registrationContext->for($appId)); - } catch (Throwable $e) { - $this->logger->logException($e, [ - 'message' => 'Error during app service registration: ' . $e->getMessage(), - 'level' => ILogger::FATAL, - ]); + $this->eventLogger->end("bootstrap:register_app:$appId:register"); } + } catch (Throwable $e) { + $this->logger->emergency('Error during app service registration: ' . $e->getMessage(), [ + 'exception' => $e, + 'app' => $appId, + ]); + $this->eventLogger->end("bootstrap:register_app:$appId"); + continue; } + $this->eventLogger->end("bootstrap:register_app:$appId"); } + $this->eventLogger->start('bootstrap:register_apps:apply', 'Apply all the registered service by apps'); /** * Now that all register methods have been called, we can delegate the registrations * to the actual services */ $this->registrationContext->delegateCapabilityRegistrations($apps); $this->registrationContext->delegateCrashReporterRegistrations($apps, $this->registry); - $this->registrationContext->delegateDashboardPanelRegistrations($apps, $this->dashboardManager); + $this->registrationContext->delegateDashboardPanelRegistrations($this->dashboardManager); $this->registrationContext->delegateEventListenerRegistrations($this->eventDispatcher); $this->registrationContext->delegateContainerRegistrations($apps); - $this->registrationContext->delegateMiddlewareRegistrations($apps); + $this->eventLogger->end('bootstrap:register_apps:apply'); + $this->eventLogger->end('bootstrap:register_apps'); } public function getRegistrationContext(): ?RegistrationContext { @@ -167,6 +160,7 @@ class Coordinator { * the instance was already created for register, but any other * (legacy) code will now do their magic via the constructor. */ + $this->eventLogger->start('bootstrap:boot_app:' . $appId, "Call `Application::boot` for $appId"); try { /** @var App $application */ $application = $this->serverContainer->query($applicationClassName); @@ -176,21 +170,21 @@ class Coordinator { $application->boot($context); } } catch (QueryException $e) { - $this->logger->logException($e, [ - 'message' => "Could not boot $appId" . $e->getMessage(), + $this->logger->error("Could not boot $appId: " . $e->getMessage(), [ + 'exception' => $e, ]); } catch (Throwable $e) { - $this->logger->logException($e, [ - 'message' => "Could not boot $appId" . $e->getMessage(), - 'level' => ILogger::FATAL, + $this->logger->emergency("Could not boot $appId: " . $e->getMessage(), [ + 'exception' => $e, ]); } + $this->eventLogger->end('bootstrap:boot_app:' . $appId); } public function isBootable(string $appId) { $appNameSpace = App::buildAppNamespace($appId); $applicationClassName = $appNameSpace . '\\AppInfo\\Application'; - return class_exists($applicationClassName) && - in_array(IBootstrap::class, class_implements($applicationClassName), true); + return class_exists($applicationClassName) + && in_array(IBootstrap::class, class_implements($applicationClassName), true); } } |