Merge pull request #33156 from nextcloud/backport/32997/stable23

[stable23] load dashboard widgets of enabled apps only
nextcloud · Aug 1, 2022 · 105bdbe · 105bdbe
2 parents bb94d2c + f955fab
commit 105bdbe
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 14 deletions.
diff --git a/lib/private/AppFramework/Bootstrap/Coordinator.php b/lib/private/AppFramework/Bootstrap/Coordinator.php
@@ -143,7 +143,7 @@ private function registerApps(array $appIds): void {
 		 */
 		$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);

diff --git a/lib/private/AppFramework/Bootstrap/RegistrationContext.php b/lib/private/AppFramework/Bootstrap/RegistrationContext.php
@@ -394,10 +394,10 @@ public function delegateCrashReporterRegistrations(array $apps, Registry $regist
 	/**
 	 * @param App[] $apps
 	 */
-	public function delegateDashboardPanelRegistrations(array $apps, IManager $dashboardManager): void {
+	public function delegateDashboardPanelRegistrations(IManager $dashboardManager): void {
 		while (($panel = array_shift($this->dashboardPanels)) !== null) {
 			try {
-				$dashboardManager->lazyRegisterWidget($panel->getService());
+				$dashboardManager->lazyRegisterWidget($panel->getService(), $panel->getAppId());
 			} catch (Throwable $e) {
 				$appId = $panel->getAppId();
 				$this->logger->error("Error during dashboard registration of $appId: " . $e->getMessage(), [

diff --git a/lib/private/Dashboard/Manager.php b/lib/private/Dashboard/Manager.php
@@ -27,11 +27,12 @@
 namespace OC\Dashboard;
 
 use InvalidArgumentException;
-use OCP\AppFramework\QueryException;
+use OCP\App\IAppManager;
 use OCP\Dashboard\IManager;
 use OCP\Dashboard\IWidget;
 use OCP\ILogger;
-use OCP\IServerContainer;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\ContainerInterface;
 use Throwable;
 
 class Manager implements IManager {
@@ -42,10 +43,13 @@ class Manager implements IManager {
 	/** @var IWidget[] */
 	private $widgets = [];
 
-	/** @var IServerContainer */
+	/** @var ContainerInterface */
 	private $serverContainer;
 
-	public function __construct(IServerContainer $serverContainer) {
+	/**	@var ?IAppManager */
+	private $appManager = null;
+
+	public function __construct(ContainerInterface $serverContainer) {
 		$this->serverContainer = $serverContainer;
 	}
 
@@ -57,17 +61,25 @@ private function registerWidget(IWidget $widget): void {
 		$this->widgets[$widget->getId()] = $widget;
 	}
 
-	public function lazyRegisterWidget(string $widgetClass): void {
-		$this->lazyWidgets[] = $widgetClass;
+	public function lazyRegisterWidget(string $widgetClass, string $appId): void {
+		$this->lazyWidgets[] = ['class' => $widgetClass, 'appId' => $appId];
 	}
 
 	public function loadLazyPanels(): void {
-		$classes = $this->lazyWidgets;
-		foreach ($classes as $class) {
+		if ($this->appManager === null) {
+			$this->appManager = $this->serverContainer->get(IAppManager::class);
+		}
+		$services = $this->lazyWidgets;
+		foreach ($services as $service) {
+			/** @psalm-suppress InvalidCatch */
 			try {
+				if (!$this->appManager->isEnabledForUser($service['appId'])) {
+					// all apps are registered, but some may not be enabled for the user
+					continue;
+				}
 				/** @var IWidget $widget */
-				$widget = $this->serverContainer->query($class);
-			} catch (QueryException $e) {
+				$widget = $this->serverContainer->get($service['class']);
+			} catch (ContainerExceptionInterface $e) {
 				/*
 				 * There is a circular dependency between the logger and the registry, so
 				 * we can not inject it. Thus the static call.

diff --git a/lib/public/Dashboard/IManager.php b/lib/public/Dashboard/IManager.php
@@ -36,7 +36,7 @@ interface IManager {
 	 * @param string $widgetClass
 	 * @since 20.0.0
 	 */
-	public function lazyRegisterWidget(string $widgetClass): void;
+	public function lazyRegisterWidget(string $widgetClass, string $appId): void;
 
 	/**
 	 * @since 20.0.0