123 lines
3.5 KiB
PHP
123 lines
3.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
|
|
*
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
|
*
|
|
* @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 OC\Dashboard;
|
|
|
|
use InvalidArgumentException;
|
|
use OCP\AppFramework\QueryException;
|
|
use OCP\Dashboard\IManager;
|
|
use OCP\Dashboard\IWidget;
|
|
use OCP\ILogger;
|
|
use OCP\IServerContainer;
|
|
use Throwable;
|
|
|
|
class Manager implements IManager {
|
|
|
|
/** @var array */
|
|
private $lazyWidgets = [];
|
|
|
|
/** @var IWidget[] */
|
|
private $widgets = [];
|
|
|
|
/** @var IServerContainer */
|
|
private $serverContainer;
|
|
|
|
public function __construct(IServerContainer $serverContainer) {
|
|
$this->serverContainer = $serverContainer;
|
|
}
|
|
|
|
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');
|
|
}
|
|
|
|
$this->widgets[$widget->getId()] = $widget;
|
|
}
|
|
|
|
public function lazyRegisterWidget(string $widgetClass): void {
|
|
$this->lazyWidgets[] = $widgetClass;
|
|
}
|
|
|
|
public function loadLazyPanels(): void {
|
|
$classes = $this->lazyWidgets;
|
|
foreach ($classes as $class) {
|
|
try {
|
|
/** @var IWidget $widget */
|
|
$widget = $this->serverContainer->query($class);
|
|
} catch (QueryException $e) {
|
|
/*
|
|
* There is a circular dependency between the logger and the registry, so
|
|
* we can not inject it. Thus the static call.
|
|
*/
|
|
\OC::$server->getLogger()->logException($e, [
|
|
'message' => 'Could not load lazy dashbaord widget: ' . $e->getMessage(),
|
|
'level' => ILogger::FATAL,
|
|
]);
|
|
}
|
|
/**
|
|
* Try to register the loaded reporter. Theoretically it could be of a wrong
|
|
* type, so we might get a TypeError here that we should catch.
|
|
*/
|
|
try {
|
|
$this->registerWidget($widget);
|
|
} catch (Throwable $e) {
|
|
/*
|
|
* There is a circular dependency between the logger and the registry, so
|
|
* we can not inject it. Thus the static call.
|
|
*/
|
|
\OC::$server->getLogger()->logException($e, [
|
|
'message' => 'Could not register lazy dashboard widget: ' . $e->getMessage(),
|
|
'level' => ILogger::FATAL,
|
|
]);
|
|
}
|
|
|
|
try {
|
|
$startTime = microtime(true);
|
|
$widget->load();
|
|
$endTime = microtime(true);
|
|
$duration = $endTime - $startTime;
|
|
if ($duration > 1) {
|
|
\OC::$server->getLogger()->error('Dashboard widget {widget} took {duration} seconds to load.', [
|
|
'widget' => $widget->getId(),
|
|
'duration' => round($duration, 2),
|
|
]);
|
|
}
|
|
} catch (Throwable $e) {
|
|
\OC::$server->getLogger()->logException($e, [
|
|
'message' => 'Error during dashboard widget loading: ' . $e->getMessage(),
|
|
'level' => ILogger::FATAL,
|
|
]);
|
|
}
|
|
}
|
|
$this->lazyWidgets = [];
|
|
}
|
|
|
|
public function getWidgets(): array {
|
|
$this->loadLazyPanels();
|
|
return $this->widgets;
|
|
}
|
|
}
|