From 69b36fc2c5835d854279b51ff795312f988218a6 Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Tue, 5 Apr 2022 18:32:46 +0200 Subject: [PATCH] Don't inject Bruteforce capability info in the webui This capability do DB access and as far I know is not used by the webui. This remove one DB query for each page load. Signed-off-by: Carl Schwan --- lib/composer/composer/autoload_classmap.php | 1 + lib/composer/composer/autoload_static.php | 1 + lib/private/CapabilitiesManager.php | 8 ++++- .../Security/Bruteforce/Capabilities.php | 3 +- lib/private/Template/JSConfigHelper.php | 2 +- .../IInitialStateExcludedCapability.php | 34 +++++++++++++++++++ 6 files changed, 46 insertions(+), 3 deletions(-) create mode 100644 lib/public/Capabilities/IInitialStateExcludedCapability.php diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 2df13618053b6..1160a934751aa 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -133,6 +133,7 @@ 'OCP\\Calendar\\Room\\IRoom' => $baseDir . '/lib/public/Calendar/Room/IRoom.php', 'OCP\\Calendar\\Room\\IRoomMetadata' => $baseDir . '/lib/public/Calendar/Room/IRoomMetadata.php', 'OCP\\Capabilities\\ICapability' => $baseDir . '/lib/public/Capabilities/ICapability.php', + 'OCP\\Capabilities\\IInitialStateExcludedCapability' => $baseDir . '/lib/public/Capabilities/IInitialStateExcludedCapability.php', 'OCP\\Capabilities\\IPublicCapability' => $baseDir . '/lib/public/Capabilities/IPublicCapability.php', 'OCP\\Collaboration\\AutoComplete\\AutoCompleteEvent' => $baseDir . '/lib/public/Collaboration/AutoComplete/AutoCompleteEvent.php', 'OCP\\Collaboration\\AutoComplete\\IManager' => $baseDir . '/lib/public/Collaboration/AutoComplete/IManager.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index cd5d30b357435..1937f3264ee73 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -162,6 +162,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Calendar\\Room\\IRoom' => __DIR__ . '/../../..' . '/lib/public/Calendar/Room/IRoom.php', 'OCP\\Calendar\\Room\\IRoomMetadata' => __DIR__ . '/../../..' . '/lib/public/Calendar/Room/IRoomMetadata.php', 'OCP\\Capabilities\\ICapability' => __DIR__ . '/../../..' . '/lib/public/Capabilities/ICapability.php', + 'OCP\\Capabilities\\IInitialStateExcludedCapability' => __DIR__ . '/../../..' . '/lib/public/Capabilities/IInitialStateExcludedCapability.php', 'OCP\\Capabilities\\IPublicCapability' => __DIR__ . '/../../..' . '/lib/public/Capabilities/IPublicCapability.php', 'OCP\\Collaboration\\AutoComplete\\AutoCompleteEvent' => __DIR__ . '/../../..' . '/lib/public/Collaboration/AutoComplete/AutoCompleteEvent.php', 'OCP\\Collaboration\\AutoComplete\\IManager' => __DIR__ . '/../../..' . '/lib/public/Collaboration/AutoComplete/IManager.php', diff --git a/lib/private/CapabilitiesManager.php b/lib/private/CapabilitiesManager.php index 16f9bd6425283..ff92ebb544448 100644 --- a/lib/private/CapabilitiesManager.php +++ b/lib/private/CapabilitiesManager.php @@ -31,6 +31,7 @@ use OCP\AppFramework\QueryException; use OCP\Capabilities\ICapability; use OCP\Capabilities\IPublicCapability; +use OCP\Capabilities\IInitialStateExcludedCapability; use Psr\Log\LoggerInterface; class CapabilitiesManager { @@ -52,7 +53,7 @@ public function __construct(LoggerInterface $logger) { * @throws \InvalidArgumentException * @return array */ - public function getCapabilities(bool $public = false) : array { + public function getCapabilities(bool $public = false, bool $initialState = false) : array { $capabilities = []; foreach ($this->capabilities as $capability) { try { @@ -66,6 +67,11 @@ public function getCapabilities(bool $public = false) : array { 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; + } $capabilities = array_replace_recursive($capabilities, $c->getCapabilities()); } } else { diff --git a/lib/private/Security/Bruteforce/Capabilities.php b/lib/private/Security/Bruteforce/Capabilities.php index 3b494d5bf49cc..5de4f35f24ea7 100644 --- a/lib/private/Security/Bruteforce/Capabilities.php +++ b/lib/private/Security/Bruteforce/Capabilities.php @@ -28,9 +28,10 @@ namespace OC\Security\Bruteforce; use OCP\Capabilities\IPublicCapability; +use OCP\Capabilities\IInitialStateExcludedCapability; use OCP\IRequest; -class Capabilities implements IPublicCapability { +class Capabilities implements IPublicCapability, IInitialStateExcludedCapability { /** @var IRequest */ private $request; diff --git a/lib/private/Template/JSConfigHelper.php b/lib/private/Template/JSConfigHelper.php index abd2ed1dcd8ab..58f3106bafdf4 100644 --- a/lib/private/Template/JSConfigHelper.php +++ b/lib/private/Template/JSConfigHelper.php @@ -187,7 +187,7 @@ public function getConfig() { $lastConfirmTimestamp = 0; } - $capabilities = $this->capabilitiesManager->getCapabilities(); + $capabilities = $this->capabilitiesManager->getCapabilities(false, true); $config = [ 'session_lifetime' => min($this->config->getSystemValue('session_lifetime', $this->iniWrapper->getNumeric('session.gc_maxlifetime')), $this->iniWrapper->getNumeric('session.gc_maxlifetime')), diff --git a/lib/public/Capabilities/IInitialStateExcludedCapability.php b/lib/public/Capabilities/IInitialStateExcludedCapability.php new file mode 100644 index 0000000000000..db1c42f7696d6 --- /dev/null +++ b/lib/public/Capabilities/IInitialStateExcludedCapability.php @@ -0,0 +1,34 @@ + + * + * @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 . + * + */ +namespace OCP\Capabilities; + +/** + * Indicate that a capability should not be injected in the initial state + * of the page as it might be expensive to query and not useful for the + * webui. + * + * @since 24.0.0 + */ +interface IInitialStateExcludedCapability { +}