Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(app-framework): Add support for global middlewares #36310

Merged
merged 1 commit into from
Jan 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
feat(app-framework): Add support for global middlewares
This allows apps to register middlewares that always register, not just
for the app's own requests

Signed-off-by: Christoph Wurst <[email protected]>
  • Loading branch information
ChristophWurst committed Jan 26, 2023
commit 8d9af3e26214f07e833a6b8d8b60329fc71916a7
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
@@ -664,6 +664,7 @@
'OC\\AppFramework\\Bootstrap\\Coordinator' => $baseDir . '/lib/private/AppFramework/Bootstrap/Coordinator.php',
'OC\\AppFramework\\Bootstrap\\EventListenerRegistration' => $baseDir . '/lib/private/AppFramework/Bootstrap/EventListenerRegistration.php',
'OC\\AppFramework\\Bootstrap\\FunctionInjector' => $baseDir . '/lib/private/AppFramework/Bootstrap/FunctionInjector.php',
'OC\\AppFramework\\Bootstrap\\MiddlewareRegistration' => $baseDir . '/lib/private/AppFramework/Bootstrap/MiddlewareRegistration.php',
'OC\\AppFramework\\Bootstrap\\ParameterRegistration' => $baseDir . '/lib/private/AppFramework/Bootstrap/ParameterRegistration.php',
'OC\\AppFramework\\Bootstrap\\PreviewProviderRegistration' => $baseDir . '/lib/private/AppFramework/Bootstrap/PreviewProviderRegistration.php',
'OC\\AppFramework\\Bootstrap\\RegistrationContext' => $baseDir . '/lib/private/AppFramework/Bootstrap/RegistrationContext.php',
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
@@ -697,6 +697,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\AppFramework\\Bootstrap\\Coordinator' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/Coordinator.php',
'OC\\AppFramework\\Bootstrap\\EventListenerRegistration' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/EventListenerRegistration.php',
'OC\\AppFramework\\Bootstrap\\FunctionInjector' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/FunctionInjector.php',
'OC\\AppFramework\\Bootstrap\\MiddlewareRegistration' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/MiddlewareRegistration.php',
'OC\\AppFramework\\Bootstrap\\ParameterRegistration' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/ParameterRegistration.php',
'OC\\AppFramework\\Bootstrap\\PreviewProviderRegistration' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/PreviewProviderRegistration.php',
'OC\\AppFramework\\Bootstrap\\RegistrationContext' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/RegistrationContext.php',
45 changes: 45 additions & 0 deletions lib/private/AppFramework/Bootstrap/MiddlewareRegistration.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

declare(strict_types=1);

/*
* @copyright 2023 Christoph Wurst <[email protected]>
*
* @author 2023 Christoph Wurst <[email protected]>
*
* @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\AppFramework\Bootstrap;

use OCP\AppFramework\Middleware;

/**
* @psalm-immutable
* @template-extends ServiceRegistration<Middleware>
*/
class MiddlewareRegistration extends ServiceRegistration {
private bool $global;

public function __construct(string $appId, string $service, bool $global) {
parent::__construct($appId, $service);
$this->global = $global;
}

public function isGlobal(): bool {
return $this->global;
}
}
13 changes: 7 additions & 6 deletions lib/private/AppFramework/Bootstrap/RegistrationContext.php
Original file line number Diff line number Diff line change
@@ -94,7 +94,7 @@ class RegistrationContext {
/** @var EventListenerRegistration[] */
private $eventListeners = [];

/** @var ServiceRegistration<Middleware>[] */
/** @var MiddlewareRegistration[] */
private $middlewares = [];

/** @var ServiceRegistration<IProvider>[] */
@@ -205,10 +205,11 @@ public function registerEventListener(string $event, string $listener, int $prio
);
}

public function registerMiddleware(string $class): void {
public function registerMiddleware(string $class, bool $global = false): void {
$this->context->registerMiddleware(
$this->appId,
$class
$class,
$global,
);
}

@@ -368,8 +369,8 @@ public function registerEventListener(string $appId, string $event, string $list
/**
* @psalm-param class-string<Middleware> $class
*/
public function registerMiddleware(string $appId, string $class): void {
$this->middlewares[] = new ServiceRegistration($appId, $class);
public function registerMiddleware(string $appId, string $class, bool $global): void {
$this->middlewares[] = new MiddlewareRegistration($appId, $class, $global);
github-advanced-security[bot] marked this conversation as resolved.
Fixed
Show resolved Hide resolved
}

public function registerSearchProvider(string $appId, string $class) {
@@ -617,7 +618,7 @@ public function delegateContainerRegistrations(array $apps): void {
}

/**
* @return ServiceRegistration<Middleware>[]
* @return MiddlewareRegistration[]
*/
public function getMiddlewareRegistrations(): array {
return $this->middlewares;
3 changes: 2 additions & 1 deletion lib/private/AppFramework/DependencyInjection/DIContainer.php
Original file line number Diff line number Diff line change
@@ -321,7 +321,8 @@ public function __construct(string $appName, array $urlParams = [], ServerContai
if ($registrationContext !== null) {
$appId = $this->getAppName();
foreach ($registrationContext->getMiddlewareRegistrations() as $middlewareRegistration) {
if ($middlewareRegistration->getAppId() === $appId) {
if ($middlewareRegistration->getAppId() === $appId
|| $middlewareRegistration->isGlobal()) {
$dispatcher->registerMiddleware($c->get($middlewareRegistration->getService()));
}
}
4 changes: 3 additions & 1 deletion lib/public/AppFramework/Bootstrap/IRegistrationContext.php
Original file line number Diff line number Diff line change
@@ -138,14 +138,16 @@ public function registerEventListener(string $event, string $listener, int $prio

/**
* @param string $class
* @param bool $global load this middleware also for requests of other apps? Added in Nextcloud 26
ChristophWurst marked this conversation as resolved.
Show resolved Hide resolved
* @psalm-param class-string<\OCP\AppFramework\Middleware> $class
*
* @return void
* @see IAppContainer::registerMiddleWare()
*
* @since 20.0.0
* @since 26.0.0 Added optional argument $global
*/
public function registerMiddleware(string $class): void;
public function registerMiddleware(string $class, bool $global = false): void;

/**
* Register a search provider for the unified search
Original file line number Diff line number Diff line change
@@ -180,7 +180,7 @@ public function dataProvider_TrueFalse() {
}

public function testGetMiddlewareRegistrations(): void {
$this->context->registerMiddleware('core', TwoFactorMiddleware::class);
$this->context->registerMiddleware('core', TwoFactorMiddleware::class, false);

$registrations = $this->context->getMiddlewareRegistrations();

38 changes: 35 additions & 3 deletions tests/lib/AppFramework/DependencyInjection/DIContainerTest.php
Original file line number Diff line number Diff line change
@@ -26,8 +26,8 @@
namespace Test\AppFramework\DependencyInjection;

use OC\AppFramework\Bootstrap\Coordinator;
use OC\AppFramework\Bootstrap\MiddlewareRegistration;
use OC\AppFramework\Bootstrap\RegistrationContext;
use OC\AppFramework\Bootstrap\ServiceRegistration;
use OC\AppFramework\DependencyInjection\DIContainer;
use OC\AppFramework\Http\Request;
use OC\AppFramework\Middleware\Security\SecurityMiddleware;
@@ -95,8 +95,40 @@ public function testMiddlewareDispatcherIncludesBootstrapMiddlewares(): void {
$registrationContext = $this->createMock(RegistrationContext::class);
$registrationContext->method('getMiddlewareRegistrations')
->willReturn([
new ServiceRegistration($this->container['appName'], 'foo'),
new ServiceRegistration('otherapp', 'bar'),
new MiddlewareRegistration($this->container['appName'], 'foo', false),
new MiddlewareRegistration('otherapp', 'bar', false),
]);
$this->container['foo'] = new class extends Middleware {
};
$this->container['bar'] = new class extends Middleware {
};
$coordinator->method('getRegistrationContext')->willReturn($registrationContext);

$dispatcher = $this->container['MiddlewareDispatcher'];

$middlewares = $dispatcher->getMiddlewares();
self::assertNotEmpty($middlewares);
foreach ($middlewares as $middleware) {
if ($middleware === $this->container['bar']) {
$this->fail('Container must not register this middleware');
}
if ($middleware === $this->container['foo']) {
// It is done
return;
}
}
$this->fail('Bootstrap registered middleware not found');
}

public function testMiddlewareDispatcherIncludesGlobalBootstrapMiddlewares(): void {
$coordinator = $this->createMock(Coordinator::class);
$this->container[Coordinator::class] = $coordinator;
$this->container['Request'] = $this->createMock(Request::class);
$registrationContext = $this->createMock(RegistrationContext::class);
$registrationContext->method('getMiddlewareRegistrations')
->willReturn([
new MiddlewareRegistration('otherapp', 'foo', true),
new MiddlewareRegistration('otherapp', 'bar', false),
]);
$this->container['foo'] = new class extends Middleware {
};