Merge pull request #21626 from nextcloud/enhancement/injectible-callables
Callable parameter injection
This commit is contained in:
commit
d3d11cb826
|
@ -56,16 +56,11 @@ class Application extends App implements IBootstrap {
|
||||||
}
|
}
|
||||||
|
|
||||||
public function boot(IBootContext $context): void {
|
public function boot(IBootContext $context): void {
|
||||||
$this->injectCss(
|
$context->injectFn([$this, 'injectCss']);
|
||||||
$context->getAppContainer()->query(IUserSession::class),
|
$context->injectFn([$this, 'registerInitialState']);
|
||||||
$context->getAppContainer()->query(IConfig::class),
|
|
||||||
$context->getAppContainer()->query(IURLGenerator::class)
|
|
||||||
);
|
|
||||||
|
|
||||||
$this->registerInitialState($context->getAppContainer());
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private function injectCss(IUserSession $userSession,
|
public function injectCss(IUserSession $userSession,
|
||||||
IConfig $config,
|
IConfig $config,
|
||||||
IURLGenerator $urlGenerator) {
|
IURLGenerator $urlGenerator) {
|
||||||
// Inject the fake css on all pages if enabled and user is logged
|
// Inject the fake css on all pages if enabled and user is logged
|
||||||
|
@ -87,10 +82,8 @@ class Application extends App implements IBootstrap {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private function registerInitialState(IAppContainer $container) {
|
public function registerInitialState(IInitialStateService $initialState,
|
||||||
/** @var IInitialStateService $initialState */
|
IAppContainer $container) {
|
||||||
$initialState = $container->query(IInitialStateService::class);
|
|
||||||
|
|
||||||
$initialState->provideLazyInitialState(self::APP_ID, 'data', function () use ($container) {
|
$initialState->provideLazyInitialState(self::APP_ID, 'data', function () use ($container) {
|
||||||
/** @var JSDataService $data */
|
/** @var JSDataService $data */
|
||||||
$data = $container->query(JSDataService::class);
|
$data = $container->query(JSDataService::class);
|
||||||
|
|
|
@ -33,6 +33,7 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace OCA\AdminAudit\AppInfo;
|
namespace OCA\AdminAudit\AppInfo;
|
||||||
|
|
||||||
|
use Closure;
|
||||||
use OC\Files\Filesystem;
|
use OC\Files\Filesystem;
|
||||||
use OC\Files\Node\File;
|
use OC\Files\Node\File;
|
||||||
use OC\Group\Manager;
|
use OC\Group\Manager;
|
||||||
|
@ -78,10 +79,9 @@ class Application extends App implements IBootstrap {
|
||||||
}
|
}
|
||||||
|
|
||||||
public function boot(IBootContext $context): void {
|
public function boot(IBootContext $context): void {
|
||||||
$logger = $this->getLogger(
|
/** @var ILogger $logger */
|
||||||
$context->getAppContainer()->query(IConfig::class),
|
$logger = $context->injectFn(
|
||||||
$context->getAppContainer()->query(ILogger::class),
|
Closure::fromCallable([$this, 'getLogger'])
|
||||||
$context->getAppContainer()->query(ILogFactory::class)
|
|
||||||
);
|
);
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|
|
@ -105,30 +105,14 @@ class Application extends App implements IBootstrap {
|
||||||
// Load all dav apps
|
// Load all dav apps
|
||||||
\OC_App::loadApps(['dav']);
|
\OC_App::loadApps(['dav']);
|
||||||
|
|
||||||
$this->registerHooks(
|
$context->injectFn([$this, 'registerHooks']);
|
||||||
$context->getAppContainer()->query(HookManager::class),
|
$context->injectFn([$this, 'registerContactsManager']);
|
||||||
$context->getServerContainer()->getEventDispatcher(),
|
$context->injectFn([$this, 'registerCalendarManager']);
|
||||||
$context->getAppContainer(),
|
$context->injectFn([$this, 'registerNotifier']);
|
||||||
$context->getServerContainer()
|
$context->injectFn([$this, 'registerCalendarReminders']);
|
||||||
);
|
|
||||||
$this->registerContactsManager(
|
|
||||||
$context->getAppContainer()->query(IContactsManager::class),
|
|
||||||
$context->getAppContainer()
|
|
||||||
);
|
|
||||||
$this->registerCalendarManager(
|
|
||||||
$context->getAppContainer()->query(ICalendarManager::class),
|
|
||||||
$context->getAppContainer()
|
|
||||||
);
|
|
||||||
$this->registerNotifier(
|
|
||||||
$context->getServerContainer()->getNotificationManager()
|
|
||||||
);
|
|
||||||
$this->registerCalendarReminders(
|
|
||||||
$context->getAppContainer()->query(NotificationProviderManager::class),
|
|
||||||
$context->getAppContainer()->query(ILogger::class)
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private function registerHooks(HookManager $hm,
|
public function registerHooks(HookManager $hm,
|
||||||
EventDispatcherInterface $dispatcher,
|
EventDispatcherInterface $dispatcher,
|
||||||
IAppContainer $container,
|
IAppContainer $container,
|
||||||
IServerContainer $serverContainer) {
|
IServerContainer $serverContainer) {
|
||||||
|
@ -349,7 +333,7 @@ class Application extends App implements IBootstrap {
|
||||||
$dispatcher->addListener('\OCP\Calendar\Room\ForceRefreshEvent', $eventHandler);
|
$dispatcher->addListener('\OCP\Calendar\Room\ForceRefreshEvent', $eventHandler);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function registerContactsManager(IContactsManager $cm, IAppContainer $container): void {
|
public function registerContactsManager(IContactsManager $cm, IAppContainer $container): void {
|
||||||
$cm->register(function () use ($container, $cm): void {
|
$cm->register(function () use ($container, $cm): void {
|
||||||
$user = \OC::$server->getUserSession()->getUser();
|
$user = \OC::$server->getUserSession()->getUser();
|
||||||
if (!is_null($user)) {
|
if (!is_null($user)) {
|
||||||
|
@ -377,7 +361,7 @@ class Application extends App implements IBootstrap {
|
||||||
$cm->setupSystemContactsProvider($contactsManager, $urlGenerator);
|
$cm->setupSystemContactsProvider($contactsManager, $urlGenerator);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function registerCalendarManager(ICalendarManager $calendarManager,
|
public function registerCalendarManager(ICalendarManager $calendarManager,
|
||||||
IAppContainer $container): void {
|
IAppContainer $container): void {
|
||||||
$calendarManager->register(function () use ($container, $calendarManager) {
|
$calendarManager->register(function () use ($container, $calendarManager) {
|
||||||
$user = \OC::$server->getUserSession()->getUser();
|
$user = \OC::$server->getUserSession()->getUser();
|
||||||
|
@ -394,11 +378,11 @@ class Application extends App implements IBootstrap {
|
||||||
$cm->setupCalendarProvider($calendarManager, $userId);
|
$cm->setupCalendarProvider($calendarManager, $userId);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function registerNotifier(INotificationManager $manager): void {
|
public function registerNotifier(INotificationManager $manager): void {
|
||||||
$manager->registerNotifierService(Notifier::class);
|
$manager->registerNotifierService(Notifier::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function registerCalendarReminders(NotificationProviderManager $manager,
|
public function registerCalendarReminders(NotificationProviderManager $manager,
|
||||||
ILogger $logger): void {
|
ILogger $logger): void {
|
||||||
try {
|
try {
|
||||||
$manager->registerProvider(AudioProvider::class);
|
$manager->registerProvider(AudioProvider::class);
|
||||||
|
|
|
@ -548,6 +548,7 @@ return array(
|
||||||
'OC\\AppFramework\\App' => $baseDir . '/lib/private/AppFramework/App.php',
|
'OC\\AppFramework\\App' => $baseDir . '/lib/private/AppFramework/App.php',
|
||||||
'OC\\AppFramework\\Bootstrap\\BootContext' => $baseDir . '/lib/private/AppFramework/Bootstrap/BootContext.php',
|
'OC\\AppFramework\\Bootstrap\\BootContext' => $baseDir . '/lib/private/AppFramework/Bootstrap/BootContext.php',
|
||||||
'OC\\AppFramework\\Bootstrap\\Coordinator' => $baseDir . '/lib/private/AppFramework/Bootstrap/Coordinator.php',
|
'OC\\AppFramework\\Bootstrap\\Coordinator' => $baseDir . '/lib/private/AppFramework/Bootstrap/Coordinator.php',
|
||||||
|
'OC\\AppFramework\\Bootstrap\\FunctionInjector' => $baseDir . '/lib/private/AppFramework/Bootstrap/FunctionInjector.php',
|
||||||
'OC\\AppFramework\\Bootstrap\\RegistrationContext' => $baseDir . '/lib/private/AppFramework/Bootstrap/RegistrationContext.php',
|
'OC\\AppFramework\\Bootstrap\\RegistrationContext' => $baseDir . '/lib/private/AppFramework/Bootstrap/RegistrationContext.php',
|
||||||
'OC\\AppFramework\\DependencyInjection\\DIContainer' => $baseDir . '/lib/private/AppFramework/DependencyInjection/DIContainer.php',
|
'OC\\AppFramework\\DependencyInjection\\DIContainer' => $baseDir . '/lib/private/AppFramework/DependencyInjection/DIContainer.php',
|
||||||
'OC\\AppFramework\\Http' => $baseDir . '/lib/private/AppFramework/Http.php',
|
'OC\\AppFramework\\Http' => $baseDir . '/lib/private/AppFramework/Http.php',
|
||||||
|
|
|
@ -577,6 +577,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
|
||||||
'OC\\AppFramework\\App' => __DIR__ . '/../../..' . '/lib/private/AppFramework/App.php',
|
'OC\\AppFramework\\App' => __DIR__ . '/../../..' . '/lib/private/AppFramework/App.php',
|
||||||
'OC\\AppFramework\\Bootstrap\\BootContext' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/BootContext.php',
|
'OC\\AppFramework\\Bootstrap\\BootContext' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/BootContext.php',
|
||||||
'OC\\AppFramework\\Bootstrap\\Coordinator' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/Coordinator.php',
|
'OC\\AppFramework\\Bootstrap\\Coordinator' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/Coordinator.php',
|
||||||
|
'OC\\AppFramework\\Bootstrap\\FunctionInjector' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/FunctionInjector.php',
|
||||||
'OC\\AppFramework\\Bootstrap\\RegistrationContext' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/RegistrationContext.php',
|
'OC\\AppFramework\\Bootstrap\\RegistrationContext' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Bootstrap/RegistrationContext.php',
|
||||||
'OC\\AppFramework\\DependencyInjection\\DIContainer' => __DIR__ . '/../../..' . '/lib/private/AppFramework/DependencyInjection/DIContainer.php',
|
'OC\\AppFramework\\DependencyInjection\\DIContainer' => __DIR__ . '/../../..' . '/lib/private/AppFramework/DependencyInjection/DIContainer.php',
|
||||||
'OC\\AppFramework\\Http' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Http.php',
|
'OC\\AppFramework\\Http' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Http.php',
|
||||||
|
|
|
@ -45,4 +45,8 @@ class BootContext implements IBootContext {
|
||||||
public function getServerContainer(): IServerContainer {
|
public function getServerContainer(): IServerContainer {
|
||||||
return $this->appContainer->getServer();
|
return $this->appContainer->getServer();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function injectFn(callable $fn) {
|
||||||
|
return (new FunctionInjector($this->appContainer))->injectFn($fn);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,69 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
|
||||||
|
*
|
||||||
|
* @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
|
||||||
|
*
|
||||||
|
* @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 Closure;
|
||||||
|
use OCP\AppFramework\QueryException;
|
||||||
|
use OCP\IContainer;
|
||||||
|
use ReflectionFunction;
|
||||||
|
use ReflectionParameter;
|
||||||
|
use function array_map;
|
||||||
|
|
||||||
|
class FunctionInjector {
|
||||||
|
|
||||||
|
/** @var IContainer */
|
||||||
|
private $container;
|
||||||
|
|
||||||
|
public function __construct(IContainer $container) {
|
||||||
|
$this->container = $container;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function injectFn(callable $fn) {
|
||||||
|
$reflected = new ReflectionFunction(Closure::fromCallable($fn));
|
||||||
|
return $fn(...array_map(function (ReflectionParameter $param) {
|
||||||
|
// First we try by type (more likely these days)
|
||||||
|
if (($type = $param->getType()) !== null) {
|
||||||
|
try {
|
||||||
|
return $this->container->query($type->getName());
|
||||||
|
} catch (QueryException $ex) {
|
||||||
|
// Ignore and try name as well
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Second we try by name (mostly for primitives)
|
||||||
|
try {
|
||||||
|
return $this->container->query($param->getName());
|
||||||
|
} catch (QueryException $ex) {
|
||||||
|
// As a last resort we pass `null` if allowed
|
||||||
|
if ($type !== null && $type->allowsNull()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nothing worked, time to bail out
|
||||||
|
throw $ex;
|
||||||
|
}
|
||||||
|
}, $reflected->getParameters()));
|
||||||
|
}
|
||||||
|
}
|
|
@ -26,7 +26,9 @@ declare(strict_types=1);
|
||||||
namespace OCP\AppFramework\Bootstrap;
|
namespace OCP\AppFramework\Bootstrap;
|
||||||
|
|
||||||
use OCP\AppFramework\IAppContainer;
|
use OCP\AppFramework\IAppContainer;
|
||||||
|
use OCP\AppFramework\QueryException;
|
||||||
use OCP\IServerContainer;
|
use OCP\IServerContainer;
|
||||||
|
use Throwable;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @since 20.0.0
|
* @since 20.0.0
|
||||||
|
@ -52,4 +54,24 @@ interface IBootContext {
|
||||||
* @since 20.0.0
|
* @since 20.0.0
|
||||||
*/
|
*/
|
||||||
public function getServerContainer(): IServerContainer;
|
public function getServerContainer(): IServerContainer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invoke the given callable and inject all parameters based on their types
|
||||||
|
* and names
|
||||||
|
*
|
||||||
|
* Note: when used with methods, make sure they are public or use \Closure::fromCallable
|
||||||
|
* to wrap the private method call, e.g.
|
||||||
|
* * `$context->injectFn([$obj, 'publicMethod'])`
|
||||||
|
* * `$context->injectFn([$this, 'publicMethod'])`
|
||||||
|
* * `$context->injectFn(\Closure::fromCallable([$this, 'privateMethod']))`
|
||||||
|
*
|
||||||
|
* Note: the app container will be queried
|
||||||
|
*
|
||||||
|
* @param callable $fn
|
||||||
|
* @throws QueryException if at least one of the parameter can't be resolved
|
||||||
|
* @throws Throwable any error the function invocation might cause
|
||||||
|
* @return mixed|null the return value of the invoked function, if any
|
||||||
|
* @since 20.0.0
|
||||||
|
*/
|
||||||
|
public function injectFn(callable $fn);
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,84 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
|
||||||
|
*
|
||||||
|
* @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
|
||||||
|
*
|
||||||
|
* @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 lib\AppFramework\Bootstrap;
|
||||||
|
|
||||||
|
use OC\AppFramework\Bootstrap\FunctionInjector;
|
||||||
|
use OC\AppFramework\Utility\SimpleContainer;
|
||||||
|
use Test\TestCase;
|
||||||
|
|
||||||
|
interface Foo {
|
||||||
|
}
|
||||||
|
|
||||||
|
class FunctionInjectorTest extends TestCase {
|
||||||
|
|
||||||
|
/** @var SimpleContainer */
|
||||||
|
private $container;
|
||||||
|
|
||||||
|
protected function setUp(): void {
|
||||||
|
parent::setUp();
|
||||||
|
|
||||||
|
$this->container = new SimpleContainer();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInjectFnNotRegistered(): void {
|
||||||
|
$this->expectException(\OCP\AppFramework\QueryException::class);
|
||||||
|
|
||||||
|
(new FunctionInjector($this->container))->injectFn(static function (Foo $p1): void {
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInjectFnNotRegisteredButNullable(): void {
|
||||||
|
(new FunctionInjector($this->container))->injectFn(static function (?Foo $p1): void {
|
||||||
|
});
|
||||||
|
|
||||||
|
// Nothing to assert. No errors means everything is fine.
|
||||||
|
$this->addToAssertionCount(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInjectFnByType(): void {
|
||||||
|
$this->container->registerService(Foo::class, function () {
|
||||||
|
$this->addToAssertionCount(1);
|
||||||
|
return new class implements Foo {
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
(new FunctionInjector($this->container))->injectFn(static function (Foo $p1): void {
|
||||||
|
});
|
||||||
|
|
||||||
|
// Nothing to assert. No errors means everything is fine.
|
||||||
|
$this->addToAssertionCount(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInjectFnByName(): void {
|
||||||
|
$this->container->registerParameter('test', 'abc');
|
||||||
|
|
||||||
|
(new FunctionInjector($this->container))->injectFn(static function ($test): void {
|
||||||
|
});
|
||||||
|
|
||||||
|
// Nothing to assert. No errors means everything is fine.
|
||||||
|
$this->addToAssertionCount(1);
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,5 +1,7 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ownCloud - App Framework
|
* ownCloud - App Framework
|
||||||
*
|
*
|
||||||
|
@ -67,6 +69,7 @@ class SimpleContainerTest extends \Test\TestCase {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
public function testRegister() {
|
public function testRegister() {
|
||||||
$this->container->registerParameter('test', 'abc');
|
$this->container->registerParameter('test', 'abc');
|
||||||
$this->assertEquals('abc', $this->container->query('test'));
|
$this->assertEquals('abc', $this->container->query('test'));
|
||||||
|
|
Loading…
Reference in New Issue