aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/CapabilitiesManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/CapabilitiesManager.php')
-rw-r--r--lib/private/CapabilitiesManager.php76
1 files changed, 42 insertions, 34 deletions
diff --git a/lib/private/CapabilitiesManager.php b/lib/private/CapabilitiesManager.php
index 6a4d97ad159..07076d9aacd 100644
--- a/lib/private/CapabilitiesManager.php
+++ b/lib/private/CapabilitiesManager.php
@@ -1,75 +1,83 @@
<?php
declare(strict_types=1);
-
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Julius Härtl <jus@bitgrid.net>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC;
use OCP\AppFramework\QueryException;
use OCP\Capabilities\ICapability;
+use OCP\Capabilities\IInitialStateExcludedCapability;
use OCP\Capabilities\IPublicCapability;
-use OCP\ILogger;
+use Psr\Log\LoggerInterface;
class CapabilitiesManager {
+ /**
+ * Anything above 0.1s to load the capabilities of an app qualifies for bad code
+ * and should be cached within the app.
+ */
+ public const ACCEPTABLE_LOADING_TIME = 0.1;
/** @var \Closure[] */
private $capabilities = [];
- /** @var ILogger */
+ /** @var LoggerInterface */
private $logger;
- public function __construct(ILogger $logger) {
+ public function __construct(LoggerInterface $logger) {
$this->logger = $logger;
}
/**
- * Get an array of al the capabilities that are registered at this manager
+ * Get an array of all the capabilities that are registered at this manager
*
* @param bool $public get public capabilities only
* @throws \InvalidArgumentException
- * @return array
+ * @return array<string, mixed>
*/
- public function getCapabilities(bool $public = false) : array {
+ public function getCapabilities(bool $public = false, bool $initialState = false) : array {
$capabilities = [];
foreach ($this->capabilities as $capability) {
try {
$c = $capability();
} catch (QueryException $e) {
- $this->logger->logException($e, [
- 'message' => 'CapabilitiesManager',
- 'level' => ILogger::ERROR,
- 'app' => 'core',
+ $this->logger->error('CapabilitiesManager', [
+ 'exception' => $e,
]);
continue;
}
if ($c instanceof ICapability) {
if (!$public || $c instanceof IPublicCapability) {
+ if ($initialState && ($c instanceof IInitialStateExcludedCapability)) {
+ // Remove less important capabilities information that are expensive to query
+ // that we would otherwise inject to every page load
+ continue;
+ }
+ $startTime = microtime(true);
$capabilities = array_replace_recursive($capabilities, $c->getCapabilities());
+ $endTime = microtime(true);
+ $timeSpent = $endTime - $startTime;
+ if ($timeSpent > self::ACCEPTABLE_LOADING_TIME) {
+ $logLevel = match (true) {
+ $timeSpent > self::ACCEPTABLE_LOADING_TIME * 16 => \OCP\ILogger::FATAL,
+ $timeSpent > self::ACCEPTABLE_LOADING_TIME * 8 => \OCP\ILogger::ERROR,
+ $timeSpent > self::ACCEPTABLE_LOADING_TIME * 4 => \OCP\ILogger::WARN,
+ $timeSpent > self::ACCEPTABLE_LOADING_TIME * 2 => \OCP\ILogger::INFO,
+ default => \OCP\ILogger::DEBUG,
+ };
+ $this->logger->log(
+ $logLevel,
+ 'Capabilities of {className} took {duration} seconds to generate.',
+ [
+ 'className' => get_class($c),
+ 'duration' => round($timeSpent, 2),
+ ]
+ );
+ }
}
} else {
throw new \InvalidArgumentException('The given Capability (' . get_class($c) . ') does not implement the ICapability interface');