123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131 |
- <?php
- declare(strict_types=1);
- namespace OC\Dashboard;
- use InvalidArgumentException;
- use OCP\App\IAppManager;
- use OCP\Dashboard\IConditionalWidget;
- use OCP\Dashboard\IManager;
- use OCP\Dashboard\IWidget;
- use Psr\Container\ContainerExceptionInterface;
- use Psr\Container\ContainerInterface;
- use Psr\Log\LoggerInterface;
- use Throwable;
- class Manager implements IManager {
-
- private $lazyWidgets = [];
-
- private array $widgets = [];
- private ?IAppManager $appManager = null;
- public function __construct(
- private ContainerInterface $serverContainer,
- private LoggerInterface $logger,
- ) {
- }
- private function registerWidget(IWidget $widget): void {
- if (array_key_exists($widget->getId(), $this->widgets)) {
- throw new InvalidArgumentException('Dashboard widget with this id has already been registered');
- }
- if (!preg_match('/^[a-z][a-z0-9\-_]*$/', $widget->getId())) {
- $this->logger->debug('Deprecated dashboard widget ID provided: "' . $widget->getId() . '" [ ' . get_class($widget) . ' ]. Please use a-z, 0-9, - and _ only, starting with a-z');
- }
- $this->widgets[$widget->getId()] = $widget;
- }
- public function lazyRegisterWidget(string $widgetClass, string $appId): void {
- $this->lazyWidgets[] = ['class' => $widgetClass, 'appId' => $appId];
- }
- public function loadLazyPanels(): void {
- if ($this->appManager === null) {
- $this->appManager = $this->serverContainer->get(IAppManager::class);
- }
- $services = $this->lazyWidgets;
- foreach ($services as $service) {
-
- try {
- if (!$this->appManager->isEnabledForUser($service['appId'])) {
-
- continue;
- }
-
- $widget = $this->serverContainer->get($service['class']);
- } catch (ContainerExceptionInterface $e) {
-
- \OC::$server->get(LoggerInterface::class)->critical(
- 'Could not load lazy dashboard widget: ' . $service['class'],
- ['exception' => $e]
- );
- continue;
- }
-
- try {
- if ($widget instanceof IConditionalWidget && !$widget->isEnabled()) {
- continue;
- }
- $this->registerWidget($widget);
- } catch (Throwable $e) {
-
- \OC::$server->get(LoggerInterface::class)->critical(
- 'Could not register lazy dashboard widget: ' . $service['class'],
- ['exception' => $e]
- );
- continue;
- }
- try {
- $startTime = microtime(true);
- $widget->load();
- $endTime = microtime(true);
- $duration = $endTime - $startTime;
- if ($duration > 1) {
- \OC::$server->get(LoggerInterface::class)->info(
- 'Dashboard widget {widget} took {duration} seconds to load.',
- [
- 'widget' => $widget->getId(),
- 'duration' => round($duration, 2),
- ]
- );
- }
- } catch (Throwable $e) {
- \OC::$server->get(LoggerInterface::class)->critical(
- 'Error during dashboard widget loading: ' . $service['class'],
- ['exception' => $e]
- );
- continue;
- }
- }
- $this->lazyWidgets = [];
- }
-
- public function getWidgets(): array {
- $this->loadLazyPanels();
- return $this->widgets;
- }
- }
|